Salta al contenuto principale
@capgo/capacitor-file File & Storage Open source

File Plugin Capacitor

Plugin completo per il file system per leggere, scrivere e gestire file e directory

Installa

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

Guida

Come usare File in Capacitor

Utilizzo di @capgo/capacitor-file

Il plugin Capacitor File implementa operazioni sul file system simili al plugin Cordova File.

Installa

bun add @capgo/capacitor-file
bunx cap sync

bunx cap sync copia i code nativi del plugin nei tuoi progetti nativi. Eseguilo di nuovo dopo ogni aggiornamento del plugin.

Importa

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

API in breve

Metodo Descrizione
requestFileSystem Richiedi un file system.
resolveLocalFileSystemURL Risolvi un URL di file in un'entry.
getFile Ottieni un'entry di file.
getDirectory Ottieni una entry di directory.
readFile Leggi un file come testo o base64.
readAsDataURL Leggi un file come data URL (base64 con prefisso del tipo MIME).
writeFile Scrivi dei dati in un file.
appendFile Aggiunge dati a un file.
deleteFile Elimina un file.
mkdir Crea una directory.
rmdir Elimina una directory.
readdir Legge il contenuto di una directory.
stat Ottiene i metadati di un file o di una directory.
getMetadata Ottiene i metadati di un file o di una directory. Alias di stat().
rename Rinomina o sposta un file o una directory.
move Sposta un file o una directory. Alias di rename().
copy Copia un file o una directory.
exists Verifica se esiste un file o una directory.
getUri Ottiene l'URI di un file.
truncate Tronca un file alla dimensione specificata.
getDirectories Ottieni tutte le directory conosciute del file system.
getFreeDiskSpace Ottieni lo spazio libero su disco in byte.
checkPermissions Verifica lo stato attuale dei permessi per le operazioni sui file. Su Android, controlla i permessi per l'archiviazione esterna. Su iOS e web, restituisce sempre 'granted' poiché non sono necessari permessi speciali.
requestPermissions Richiede i permessi per le operazioni sui file. Su Android, richiede i permessi per l'archiviazione esterna necessari per accedere ai file al di fuori delle directory private dell'app. Su iOS e web, restituisce sempre 'granted' poiché non sono necessari permessi speciali.

Esempi

requestFileSystem()

Richiedi un file system.

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

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

resolveLocalFileSystemURL()

Risolvi un URL di file in un'entry.

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

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

getFile()

Ottieni un'entry di file.

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

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

getDirectory()

Ottieni una entry di directory.

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

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

readFile()

Leggi un file come testo o base64.

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

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

readAsDataURL()

Leggi un file come data URL (base64 con prefisso del tipo MIME).

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

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

La tabella sopra elenca i 24 metodi core. I listener, gli helper di versione e il contratto completo di ogni metodo sono documentati in repository GitHub.

Ascolta gli eventi

addListener restituisce un handle. Chiama handle.remove() quando la schermata viene smontata, o CapacitorFile.removeAllListeners() per rimuovere tutti i listener.

Riferimento completo

Continua da Utilizzo di @capgo/capacitor-file

Se stai usando Utilizzo di @capgo/capacitor-file per pianificare lo storage e la gestione dei file, collegalo a @capgo/capacitor-file per i dettagli di implementazione in @capgo/capacitor-file, Per iniziare per i dettagli di implementazione nella guida introduttiva, @capgo/capacitor-data-storage-sqlite per i dettagli di implementazione in @capgo/capacitor-data-storage-sqlite, Utilizzo di @capgo/capacitor-data-storage-sqlite per la funzionalità nativa in Utilizzo di @capgo/capacitor-data-storage-sqlite, e @capgo/capacitor-uploader per i dettagli implementativi in @capgo/capacitor-uploader.

FAQ

FAQ sul plugin File

Come installo il plugin File in un'app Capacitor?

Esegui "bun add @capgo/capacitor-file" (o "npm install @capgo/capacitor-file"), poi esegui "bunx cap sync" così che i progetti iOS e Android includano il codice nativo code. Importalo da "@capgo/capacitor-file" nel code della tua app.

@capgo/capacitor-file funziona con React, Vue e Angular?

Sì. File è un pacchetto Capacitor, quindi funziona con qualsiasi framework web che gira dentro Capacitor, inclusi Ionic, React, Vue, Angular, Svelte e JavaScript puro.

Quale versione di Capacitor supporta @capgo/capacitor-file?

I plugin Capgo seguono la major version di Capacitor: usa la major version del plugin che corrisponde alla tua major version di Capacitor (ad esempio plugin v8 con Capacitor 8). La tabella di compatibilità nel README di GitHub elenca le versioni mantenute.

@capgo/capacitor-file è gratuito e open source?

Sì. Il code sorgente è pubblico su GitHub all'indirizzo https://github.com/Cap-go/capacitor-file/ e il pacchetto è gratuito da installare da npm. Bug report e pull request sono benvenuti.

Posso aggiornare code che usa File senza passare dalla revisione dell'App Store?

Installare o aggiornare il plugin modifica il code nativo, quindi serve una nuova build per lo store. Dopo, le modifiche a JavaScript, HTML e CSS che chiamano il plugin possono essere rilasciate subito con le live updates di Capgo.

Pubblica modifiche a File senza aspettare la revisione dell'app

Una volta incluso il plugin nel tuo store build, Capgo invia le modifiche a JavaScript, HTML e CSS tramite live updates in pochi minuti.

Inizia con Capgo