Getting Started

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Luego utiliza el siguiente prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-file-picker` plugin in my project.

Si prefieres la configuración manual, instala el complemento ejecutando los siguientes comandos y sigue las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-file-picker
bunx cap sync

Importar

import { CapgoFilePicker } from '@capgo/capacitor-file-picker';

API Resumen

pickFiles

Seleccione uno o más archivos del dispositivo.

import { CapgoFilePicker } from '@capgo/capacitor-file-picker';

const result = await CapgoFilePicker.pickFiles({
  types: ['application/pdf', 'image/*'],
  limit: 5,
  readData: false
});
console.log('Picked files:', result.files);

pickImages

Seleccione uno o más imágenes de la galería. Solo para Android/iOS.

import { CapgoFilePicker } from '@capgo/capacitor-file-picker';

const result = await CapgoFilePicker.pickImages({
  limit: 10,
  readData: false
});
console.log('Picked images:', result.files);

pickVideos

Seleccione uno o más videos de la galería. Solo para Android/iOS.

import { CapgoFilePicker } from '@capgo/capacitor-file-picker';

const result = await CapgoFilePicker.pickVideos({
  limit: 3,
  skipTranscoding: true
});
console.log('Picked videos:', result.files);

pickMedia

Seleccione una o varias imágenes o videos de la galería. Solo para Android/iOS.

import { CapgoFilePicker } from '@capgo/capacitor-file-picker';

const result = await CapgoFilePicker.pickMedia({
  limit: 5,
  readData: true
});
console.log('Picked media:', result.files);

pickDirectory

Seleccione un directorio del dispositivo. Solo para Android/iOS.

import { CapgoFilePicker } from '@capgo/capacitor-file-picker';

const result = await CapgoFilePicker.pickDirectory();
console.log('Selected directory:', result.path);

convertHeicToJpeg

Convierta una imagen HEIC a formato JPEG. Solo para iOS.

import { CapgoFilePicker } from '@capgo/capacitor-file-picker';

const result = await CapgoFilePicker.convertHeicToJpeg({
  path: '/path/to/image.heic',
  quality: 0.9
});
console.log('Converted file:', result.path);

copyFile

Copie un archivo a una ubicación nueva.

import { CapgoFilePicker } from '@capgo/capacitor-file-picker';

await CapgoFilePicker.copyFile({
  from: '/source/file.pdf',
  to: '/destination/file.pdf',
  overwrite: true
});

checkPermissions

Verificar permisos para leer archivos. Solo para Android.

import { CapgoFilePicker } from '@capgo/capacitor-file-picker';

const status = await CapgoFilePicker.checkPermissions();
console.log('Read permission:', status.readExternalStorage);

requestPermissions

Solicitar permisos para leer archivos. Solo para Android.

import { CapgoFilePicker } from '@capgo/capacitor-file-picker';

const status = await CapgoFilePicker.requestPermissions();
if (status.readExternalStorage === 'granted') {
  console.log('Permission granted');
}

Referencia de tipo

PickFilesOptions

Opciones para seleccionar archivos.

export interface PickFilesOptions {
  /**
   * List of accepted MIME types or file extensions.
   * On iOS, only MIME types are supported.
   * Examples: ['image/*'], ['application/pdf'], ['.pdf', '.doc']
   */
  types?: string[];
  /**
   * Maximum number of files to pick.
   * Set to 0 for unlimited (platform default).
   * @default 0
   */
  limit?: number;
  /**
   * Whether to read the file data as base64.
   * Note: Reading large files may cause memory issues.
   * @default false
   */
  readData?: boolean;
}

PickFilesResult

Resultado de seleccionar archivos.

export interface PickFilesResult {
  /** Array of picked files */
  files: PickedFile[];
}

PickMediaOptions

Opciones para seleccionar medios (imágenes/videos).

export interface PickMediaOptions {
  /**
   * Maximum number of files to pick.
   * Set to 0 for unlimited (platform default).
   * @default 0
   */
  limit?: number;
  /**
   * Whether to read the file data as base64.
   * Note: Reading large files may cause memory issues.
   * @default false
   */
  readData?: boolean;
  /**
   * iOS only: Skip transcoding of videos.
   * @default false
   */
  skipTranscoding?: boolean;
  /**
   * iOS 15+ only: Show ordered selection badges.
   * @default false
   */
  ordered?: boolean;
}

PickDirectoryResult

Resultado de seleccionar un directorio.

export interface PickDirectoryResult {
  /** The path to the selected directory */
  path: string;
}

ConvertHeicToJpegOptions

Opciones para convertir HEIC a JPEG.

export interface ConvertHeicToJpegOptions {
  /** The path to the HEIC file to convert */
  path: string;
  /**
   * The compression quality for JPEG (0.0 - 1.0).
   * @default 0.9
   */
  quality?: number;
}

ConvertHeicToJpegResult

Resultado de la conversión de HEIC a JPEG.

export interface ConvertHeicToJpegResult {
  /** The path to the converted JPEG file */
  path: string;
}

CopyFileOptions

Opciones para copiar un archivo.

export interface CopyFileOptions {
  /** Source file path */
  from: string;
  /** Destination file path */
  to: string;
  /**
   * Whether to overwrite if destination exists.
   * @default false
   */
  overwrite?: boolean;
}

PermissionStatus

Estado de permiso para acceso a archivo.

export interface PermissionStatus {
  /** Whether permission to read media files is granted */
  readExternalStorage: PermissionState;
  /** Whether permission to access media location is granted */
  accessMediaLocation?: PermissionState;
}

PickerDismissedListener

Escucha de llamada para evento de picker desechado.

export type PickerDismissedListener = (event: null) => void;

PickedFile

Representa un archivo seleccionado.

export interface PickedFile {
  /** The name of the file */
  name: string;
  /** The path to the file */
  path?: string;
  /** The MIME type of the file */
  mimeType: string;
  /** The size of the file in bytes */
  size: number;
  /**
   * The base64 encoded data of the file.
   * Only present if readData was true.
   */
  data?: string;
  /**
   * The Blob instance of the file.
   * Web only.
   */
  blob?: Blob;
  /** Width in pixels (images/videos only) */
  width?: number;
  /** Height in pixels (images/videos only) */
  height?: number;
  /** Duration in seconds (videos only) */
  duration?: number;
  /** Last modified timestamp in milliseconds */
  modifiedAt?: number;
}

PermissionState

Valores de estado de permiso.

export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.tsRe-ejecuta la sincronización cuando el API público cambia en la fuente.

Sigue adelante desde Inicio

Si estás utilizando Getting Started para planificar el almacenamiento y el manejo de archivos, conectarlo con Usando @capgo/capacitor-selector-de-archivos para la capacidad nativa en Usando @capgo/capacitor-selector-de-archivos @capgo/capacitor-almacenamiento-de-datos-sqlite para el detalle de implementación en @capgo/capacitor-almacenamiento-de-datos-sqlite Usando @capgo/capacitor-almacenamiento-de-datos-sqlite para la capacidad nativa en Usando @capgo/capacitor-almacenamiento-de-datos-sqlite @capgo/capacitor-archivo para el detalle de implementación en @capgo/capacitor-archivo, y Usando @capgo/capacitor-archivo para la capacidad nativa en Usando @capgo/capacitor-archivo