alaska-segmentedcontrol HTML custom element
shell
$ npm i @phtnalaska/alaska-segmentedcontrol
`
Installing as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this stack overflow answer.
$3
The use of any Auro custom element has a dependency on the Auro Design Tokens.
$3
CSS custom properties are not supported in older browsers. For this, fallback properties are pre-generated and included with the npm.
Any update to the Auro Design Tokens will be immediately reflected with browsers that support CSS custom properties, legacy browsers will require updated components with pre-generated fallback properties.
$3
Defining the component dependency within each component that is using the component.
`js
import "@phtnalaska/alaska-segmentedcontrol";
`
Reference component in HTML
`html
`
Install bundled assets from CDN
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Two bundles are available -- alaska-segmentedcontrol__bundled.js for modern browsers and alaska-segmentedcontrol__bundled.es5.js for legacy browsers (including IE11).
Since the legacy bundle includes many polyfills that are not needed by modern browsers, we recommend you load these bundles using differential serving so that the browser only loads the bundle it needs. To accomplish this, the script tag for the modern bundle should have type="module" and the script tag for the legacy bundle should have the nomodule attribute. See the example below.
$3
`html
`
API Code Examples
$3
`html
`
Development
In order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request.
Please be sure to review the contribution guidelines for this project. Please make sure to pay special attention to the conventional commits section of the document.
$3
Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open a shell session to run the dev server.
`shell
$ npm run dev
`
Open localhost:8000
If running separate sessions is preferred, please run the following commands in individual terminal shells.
`shell
$ npm run build:watch
$ npm run serve
`
$3
The custom element API file is generated in the build and committed back to the repo with a version change. If the API doc has changed without a version change, author's are to run npm run build:api to generate the doc and commit to version control.
$3
Automated tests are required for every Auro component. See .\test\alaska-segmentedcontrol.test.js for the tests for this component. Run npm test to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See the testing documentation for more details.
$3
Bundled assets are only generated in the remote and not merged back to this repo. To review and/or test a bundled asset locally, run $ npm run bundler to generate assets.
$3
To deploy a demo version of the component for review, run npm run build:demo to create a ./build` directory that can be pushed to any static server.