Einstieg

Installieren

Sie können unsere KI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihrer KI-Tool mithilfe der folgenden Befehl hinzu:

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

Verwenden Sie dann die folgende Anfrage:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und folgen Sie den unten angegebenen Plattform-spezifischen Anweisungen:

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

Importieren

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

API Übersicht

pickFiles

Wählen Sie eine oder mehrere Dateien vom Gerät aus.

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

Wählen Sie eine oder mehrere Bilder aus der Galerie aus. Nur für 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

Wählen Sie einen oder mehrere Videos aus der Galerie. Nur für 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

Wählen Sie einen oder mehrere Bilder oder Videos aus der Galerie. Nur für 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

Wählen Sie einen Ordner vom Gerät. Nur für Android/iOS.

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

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

convertHeicToJpeg

Konvertieren Sie ein HEIC-Bild in JPEG-Format. Nur für 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

Ein Datei in einen neuen Ort kopieren.

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

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

checkPermissions

Überprüfe die Berechtigungen für das Lesen von Dateien. Nur für Android.

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

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

requestPermissions

Berechtigungen für das Lesen von Dateien anfordern. Nur für Android.

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

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

Typenverweis

PickFilesOptions

Optionen für Dateiauswahl.

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

Ergebnis der Dateiauswahl.

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

PickMediaOptions

Optionen für die Medienauswahl (Bilder/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

Ergebnis der Verzeichnisauswahl.

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

ConvertHeicToJpegOptions

Optionen für die Umwandlung von HEIC in 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

Ergebnis der HEIC in JPEG-Umwandlung.

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

CopyFileOptions

Optionen für die Kopie eines Dateisystems.

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

PermissionStatus

Zugriffsstatus für Dateien.

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

PickerDismissedListener

Listener callback für Picker abgebrochenes Ereignis.

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

PickedFile

Stellt eine ausgewählte Datei dar.

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

Werte des Zustands der Berechtigung.

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.ts. Wenn sich die öffentliche API upstream ändert, führen Sie die Synchronisation erneut durch.

Bleib weiter bei Getting Started

Wenn Sie Getting Started verwenden Getting Started um den Speicher und die Dateihandling zu planen, verbinden Sie es mit Mit @capgo/capacitor-datei-wähler für die native Fähigkeit in Mit @capgo/capacitor-datei-wähler, @capgo/capacitor-daten-speicher-sqlite für die Implementierungsdetail in @capgo/capacitor-daten-speicher-sqlite, Mit @capgo/capacitor-daten-speicher-sqlite für die native Fähigkeit in Mit @capgo/capacitor-daten-speicher-sqlite, @capgo/capacitor-datei für die Implementierungsdetails im @capgo/capacitor-Datei, und Mit der @capgo/capacitor-Datei für die native Fähigkeit in Mit der @capgo/capacitor-Datei.