docs: sync readmes with picker API
This commit is contained in:
+17
-4
@@ -1,14 +1,16 @@
|
||||
# Upload module
|
||||
|
||||
Скопируйте `upload/frontend/` и подключите собранный picker:
|
||||
Для встраивания скопируйте один готовый bundle из `dist/`:
|
||||
|
||||
- IIFE: `FilePicker.initFilePicker(config)`;
|
||||
- ESM: `import { initFilePicker } from './file-picker.esm.js'`.
|
||||
|
||||
`config` должен содержать `mount` как DOM-элемент или CSS-селектор. Основные
|
||||
параметры: `allowedExt`, `labels`, `layout`, `limits` и `onChange`.
|
||||
параметры: `allowedExt`, `labels`, `layout`, `limits`, `onChange(files)` и
|
||||
`onError(error, file)`. `onError` вызывается для ошибок разбора ZIP; обычные
|
||||
файлы с неподдерживаемым расширением просто пропускаются.
|
||||
|
||||
Публичный API таблицы:
|
||||
Публичный API picker-а:
|
||||
|
||||
- `pickFiles()` и `pickFolder()` — открыть системный выбор;
|
||||
- `getFiles()` — получить leaf-файлы с `path`, `name`, `size` и `file`;
|
||||
@@ -28,4 +30,15 @@ Picker поддерживает разрешённые документы, па
|
||||
интеграции они не нужны.
|
||||
|
||||
Подробная таблица функций, входов, выходов и побочных эффектов находится в
|
||||
[`../docs/CODE-REFERENCE.md`](../docs/CODE-REFERENCE.md).
|
||||
[`../docs/CODE-REFERENCE.md`](../docs/CODE-REFERENCE.md).
|
||||
|
||||
## Сборка из исходников
|
||||
|
||||
Исходники находятся в `frontend/`. В корне проекта:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
Результат сборки: `dist/file-picker.esm.js` и `dist/file-picker.iife.js`.
|
||||
Reference in New Issue
Block a user