Identifiers Widget
Widget to load identifiers from identifiers.org and display embedded in your webpage.
Component user docs: adding this component to your webpage
Hey! If you'd like to use this component on your webpage, please do the following:
In the <head>, add:
<!-- the library for the webcomponent -->
<script src="dist/bundle.js" type="module"></script>This links to the relevant scripts to define the component and fetch data.
In the <body>
Where you want your WebComponent to appear, add the following:
<identifiers-widget
identifier="fb:FBgn0004053">
</identifiers-widget>Some notes on usage:
- Download the bundle.js file from dist folder and link it to your index.html file.
- You may use the style.css in dist folder file for styling the component.
- Use the element like any other HTML element wherever you want.
-
attributemust be a valid identifier with a validvalue.
License
Apache - see LICENSE
Developer docs
To set up locally for development
- Clone the repo
-
cd identifiers-widgetand thennpm installto install dependencies.
All of the editable source files for css and js are in src. To bundle for prod, run the following commands in the given order:
CSS
Assuming less is installed globally:
npm run less
JS
Assuming webpack is installed globally:
Single build:
npm run build
Developing:
Run each of these commands in separate terminals:
To rebuild your js every time you save:
npm run devTo serve your page at http://localhost:3456:
npm run server