Aller au contenu principal
@capgo/capacitor-file Fichiers et stockage Open source

Fichier Plugin Capacitor

Plugin de système de fichiers complet pour lire, écrire et gérer fichiers et répertoires

Installer

bun add @capgo/capacitor-file bunx cap sync
npm, pnpm ou yarn
  • npm install @capgo/capacitor-file
  • pnpm add @capgo/capacitor-file
  • yarn add @capgo/capacitor-file

Guide

Comment utiliser File dans Capacitor

Utiliser @capgo/capacitor-file

Capacitor File Plugin Implémente des opérations du système de fichiers similaires à celles du plugin File de Cordova.

Installer

bun add @capgo/capacitor-file
bunx cap sync

bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.

Importer

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

Aperçu de API

Méthode Description
requestFileSystem Demander un système de fichiers.
resolveLocalFileSystemURL Résoudre une URL de fichier vers une entrée.
getFile Récupérer une entrée de fichier.
getDirectory Obtenir une entrée de répertoire.
readFile Lire un fichier en texte ou en base64.
readAsDataURL Lire un fichier sous forme de data URL (base64 avec préfixe MIME).
writeFile Écrire des données dans un fichier.
appendFile Ajouter des données à un fichier.
deleteFile Supprimer un fichier.
mkdir Créer un répertoire.
rmdir Supprimer un répertoire.
readdir Lire le contenu d'un répertoire.
stat Récupérer les métadonnées d'un fichier ou d'un répertoire.
getMetadata Récupérer les métadonnées d'un fichier ou d'un répertoire. Alias de stat().
rename Renommer ou déplacer un fichier ou un répertoire.
move Déplacer un fichier ou un répertoire. Alias de rename().
copy Copier un fichier ou un répertoire.
exists Vérifier si un fichier ou un répertoire existe.
getUri Récupérer l'URI d'un fichier.
truncate Tronquer un fichier à une taille spécifiée.
getDirectories Get all known file system directories.
getFreeDiskSpace Obtenir l'espace disque libre en octets.
checkPermissions Vérifier l'état actuel des permissions pour les opérations sur les fichiers. Sur Android, cela vérifie les permissions de stockage externe. Sur iOS et le web, cela retourne toujours 'granted' car aucune permission spéciale n'est requise.
requestPermissions Demander les permissions pour les opérations sur les fichiers. Sur Android, cela demande les permissions de stockage externe nécessaires pour accéder aux fichiers en dehors des répertoires privés de l'app. Sur iOS et le web, cela retourne toujours 'granted' car aucune permission spéciale n'est requise.

Exemples

requestFileSystem()

Demander un système de fichiers.

import { CapacitorFile, FileSystemType } from '@capgo/capacitor-file';

const result = await CapacitorFile.requestFileSystem({ type: FileSystemType.TEMPORARY });
console.log(result);

resolveLocalFileSystemURL()

Résoudre une URL de fichier vers une entrée.

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

const result = await CapacitorFile.resolveLocalFileSystemURL({ url: 'https://example.com' });
console.log(result);

getFile()

Récupérer une entrée de fichier.

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

const result = await CapacitorFile.getFile({ path: 'path/to/file' });
console.log(result);

getDirectory()

Obtenir une entrée de répertoire.

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

const result = await CapacitorFile.getDirectory({ path: 'path/to/file' });
console.log(result);

readFile()

Lire un fichier en texte ou en base64.

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

const result = await CapacitorFile.readFile({ path: 'path/to/file' });
console.log(result);

readAsDataURL()

Lire un fichier sous forme de data URL (base64 avec préfixe MIME).

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

const result = await CapacitorFile.readAsDataURL({ path: 'path/to/file' });
console.log(result);

Le tableau ci-dessus liste les 24 méthodes principales. Les helpers de version et de listener, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.

Écouter les événements

addListener renvoie un handle. Appelez handle.remove() lors du démontage de l'écran, ou CapacitorFile.removeAllListeners() pour supprimer tous les listeners.

Référence complète

Continuer à partir de « Utiliser @capgo/capacitor-file »

Si vous utilisez Utiliser @capgo/capacitor-file pour planifier le stockage et la gestion des fichiers, connectez-l’à @capgo/capacitor-file pour les détails d'implémentation dans @capgo/capacitor-file, Prise en main pour les détails d'implémentation dans Getting Started @capgo/capacitor-data-storage-sqlite pour les détails d'implémentation dans @capgo/capacitor-data-storage-sqlite, Utiliser @capgo/capacitor-data-storage-sqlite pour la capacité native dans Using @capgo/capacitor-data-storage-sqlite, et @capgo/capacitor-uploader pour les détails d'implémentation dans @capgo/capacitor-uploader.

FAQ

FAQ du plugin File

Comment installer le plugin File dans une application Capacitor ?

Exécutez « bun add @capgo/capacitor-file » (ou « npm install @capgo/capacitor-file »), puis lancez « bunx cap sync » pour que les projets iOS et Android récupèrent le code natif. Importez-le depuis « @capgo/capacitor-file » dans le code de votre app.

Est-ce que @capgo/capacitor-file fonctionne avec React, Vue et Angular ?

Oui. File est un package Capacitor, il fonctionne donc avec n'importe quel framework web qui s'exécute dans Capacitor, y compris Ionic, React, Vue, Angular, Svelte et le JavaScript pur.

Quelle version de Capacitor est supportée par @capgo/capacitor-file ?

Les plugins Capgo suivent la version majeure de Capacitor : utilisez la version majeure du plugin qui correspond à la version majeure de votre Capacitor (par exemple le plugin v8 avec Capacitor 8). Le tableau de compatibilité du README de GitHub recense les versions maintenues.

Est-ce que @capgo/capacitor-file est gratuit et open source ?

Oui. Le code source code est public sur GitHub à l'adresse https://github.com/Cap-go/capacitor-file/ et le package s'installe gratuitement depuis npm. Les rapports de bugs et les pull requests sont les bienvenus.

Puis-je mettre à jour code qui utilise File sans passer par une revue de l'App Store ?

L'installation ou la mise à jour du plugin modifie le code natif, ce qui impose un nouveau build pour les stores. Ensuite, les changements JavaScript, HTML et CSS qui appellent le plugin peuvent être livrés instantanément via les live updates de Capgo.

Déployez les modifications de File sans attendre la revue de l’app

Une fois le plugin intégré à votre build de store, Capgo live updates déploie vos changements JavaScript, HTML et CSS aux utilisateurs en quelques minutes.

Commencez avec Capgo