This is a collection of web components for formatting and adding interactivity to Akoma Ntoso documents.
These are web components, so they work in any major Javascript framework, or with no framework at all.
There are three methods for using these web components:
- Put a script tag similar to this
<script type="module" src="https://cdn.jsdelivr.net/npm/@lawsafrica/law-widgets@latest/dist/lawwidgets/lawwidgets.esm.js"></script>in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc
- Run
npm install @lawsafrica/law-widgets --save - Put a script tag similar to this
<script type="module" src="node_modules/@lawsafrica/law-widgets/dist/lawwidgets/lawwidgets.esm.js"></script>in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc
- Run
npm install @lawsafrica/law-widgets --save - Import the required modules in your app. They will automatically be registered as custom elements.
Example:
import '@lawsafrica/law-widgets/dist/components/la-akoma-ntoso';
import '@lawsafrica/law-widgets/dist/components/la-table-of-contents';Clone this repository and run:
npm installNeed help? Check out the Stencil docs.
Development is easiest using Storybook for testing.
Run these commands in separate terminals:
npm run build.watchnpm run storybookTo build the component for production, run:
npm run buildTo run the unit tests for the components, run:
npm run testCopyright 2022 Laws.Africa.
Licensed under GNU LGPLv3.