be-literate
TypeScript icon, indicating that this package has built-in type declarations

0.0.10 • Public • Published

be-literate (📖)

How big is this package in your project?

Enhance the input element so it can declaratively read contents from a local file (or files).

be-literate turns this code snippet into an attribute-based HTML Enhancement / Decorator / Behavior / Directive / Custom Attribute.

Syntax:

<input type=file be-literate onload="
    const {fileContents} = event;
    console.log({fileContents});
">

It causes the input element to emit event "load", and the contents are provided in the event's fileContents. In case other fellow enhancements are "overloading" the onload event in this way, check that the event's "enh" value is set to the name of the enhancement within the Shadow Realm ('beLiterate' or '📖', for example) before proceeding.

The file contents can be read via path: inputEl.beEnhanced.beLiterate.fileContents.

In a closed environment, where the chances of clashes with other custom attributes can be controlled, consider using a smaller name, like 📖, by referencing an alternate EMC file:

<input type=file 📖 onload="
    const {fileContents} = event;
    console.log({fileContents});
">

Specifying Read Option

To specify which of the file read options to apply to the file(s), set the attribute:

<input type=file 📖='{"readVerb": "readAsDataURL"}' >

If not specified, as above, the default is readAsText.

Running locally

Any web server than can serve static files will do, but...

  1. Install git.
  2. Do a git clone or a git fork of repository https://github.com/bahrus/be-literate
  3. Install node.js
  4. Open command window to folder where you cloned this repo.
  5. npm install

  6. npm run serve

  7. Open http://localhost:3030/demo/dev in a modern browser.

Using from ESM Module:

import 'be-literate/behivior.js';

Using from CDN:

<script type=module crossorigin=anonymous>
    import 'https://esm.run/be-literate';
</script>

Dependents (0)

Package Sidebar

Install

npm i be-literate

Weekly Downloads

30

Version

0.0.10

License

MIT

Unpacked Size

11.9 kB

Total Files

7

Last publish

Collaborators

  • bahrus