@sumit_yewale/angular 1.1.18 → 1.1.20

package/README.md

@@ -83,6 +83,47 @@ export class AppComponent {
 | `isSubmitted`   | Triggers when the user hits the 'Submit' button to upload the validated file. **data** object is available in this event. It contains metadata related to the import.|
 | `isImported`   | Triggers when the data is pushed to the destination.<br>Two objects are available in this event:<br>1. result (boolean): It is true when the import is successful and false when the import fails.<br>2. data (object): Contains metadata related to the import.|
 
+## Importing a file you already have
+
+`openModalWithFile(file)` opens the importer on a `File` your own page is holding — from your
+own drop target, your own file input, anything — instead of the importer's file picker. The
+file still goes through the importer's extension, worksheet and size checks; this skips the
+picker, not the validation.
+
+Call it through a template reference variable:
+
+```html
+<csvbox-button #importer [licenseKey]="licenseKey" [user]="user" [isImported]="isImported.bind(this)">
+  Import
+</csvbox-button>
+
+<input type="file" (change)="importer.openModalWithFile($any($event.target).files[0])" />
+```
+
+or from the component class with `@ViewChild(CSVBoxButtonComponent) importer: CSVBoxButtonComponent;`
+and `this.importer.openModalWithFile(file)`.
+
+The importer can decline a file it is handed, and says why in a console warning
+(`[csvbox] importer declined the supplied file: <reason>`):
+
+- `import-in-progress` — the importer is open past its upload step, or is still reading an
+  earlier file. An import that is already open stays open.
+- `modal-closing` — the importer was closing when the file arrived.
+- `import-file-url-configured` — the sheet is set up to load its own file from a URL.
+
+Pass a `File`, not a `Blob`: a `Blob` has no name to read an extension from, and anything that
+is not a `File` is ignored.
+
+When the importer redirects to another host (data-location sheets do this), the file is sent to the host the importer actually ended up on, as long as that host is your importer domain or `<region>-<your domain>` (for example `eu-app.csvbox.io` for `app.csvbox.io`). A file is never sent to any other host.
+
+If the importer does not answer a supplied file within about 8 seconds (for example because it redirected to a host that does not follow that naming, or it is too old to know the message), the importer is put away, the other buttons are enabled again, and the console says `[csvbox] the importer did not respond to the supplied file`.
+
+## Several importers on one page
+
+While an importer is open (or still loading to open), the button of every other CSVBox instance on the page is disabled until it closes, so two importers are not opened by accident. In React, the second argument of the `render` prop (`isLoading`) is also `true` in that state, so a custom trigger can disable itself the same way.
+
+Opening a second importer from code (`openModal()` or `openModalWithFile()`) is still possible. The importer opened last is shown on top of the others, and closing it reveals the one underneath.
+
 ## Readme
 
 For usage see the guide here - https://help.csvbox.io/getting-started#2-install-code