0.0.1 • Published 4 years ago

@bcodes/json-file-input v0.0.1

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

bc-json-file-input

Example Usage

<bc-json-file-input multiple preview-json>
    <!-- Any element can be used in place of a button -->
    <button>Upload Files</button>
</bc-json-file-input>

Button Styling

The slotted element (<button> in the example above) is outside of the Shadow DOM and can be styled externally

Global Css Variables

The following CSS variabels can be overriden globally

:root {
    --bc-preview-background: #212020;
    --bc-preview-color: #40c64c;
    --bc-preview-font-family: sans-serif;
    --bc-preview-error: #791313
}

Properties

PropertyAttributeDescriptionTypeDefault
multiplemultiplebooleanfalse
objectToConsoleconsole-logbooleanfalse
previewJsonpreview-jsonbooleanfalse

Events

EventDescriptionType
filesLoadedEvent emitted when files have been loadedCustomEvent<File[]>
filesReadEvent emitted when files have been read (using FileReader)CustomEvent<readonly IFileData[]>

Dependencies

Depends on

Graph

graph TD;
  bc-json-file-input --> bc-json-preview
  style bc-json-file-input fill:#f9f,stroke:#333,stroke-width:4px

Built with StencilJS

Stencil Docs

https://stenciljs.com/docs/decorators

Using this component

Script tag

  • Publish to NPM
  • Put a script tag similar to this <script src='https://unpkg.com/my-component@0.0.1/dist/mycomponent.js'></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

Node Modules

  • Run npm install my-component --save
  • Put a script tag similar to this <script src='node_modules/my-component/dist/mycomponent.js'></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

In a stencil-starter app

  • Run npm install my-component --save
  • Add an import to the npm packages import my-component;
  • Then you can use the element anywhere in your template, JSX, html etc
0.0.1

4 years ago