@internetarchive/ia-activity-indicator
v0.0.5-alpha1
Published
Webcomponent ia-activity-indicator following open-wc recommendations
Downloads
809
Maintainers
Keywords
Readme
IA Activity Indicator
A customizable activity indicator.
Installation
yarn add @internetarchive/ia-activity-indicator
Usage
<script type="module">
import '@internetarchive/ia-activity-indicator/ia-activity-indicator';
</script>
<style>
ia-activity-indicator {
width: 100px;
height: 100px;
display: block;
--activityIndicatorLoadingDotColor: purple;
--activityIndicatorLoadingRingColor: green;
--activityIndicatorCheckmarkColor: green;
--activityIndicatorCompletedRingColor: purple;
}
</style>
<ia-activity-indicator mode="processing"> <!-- or "complete" -->
</ia-activity-indicator>
Linting with ESLint, Prettier, and Types
To scan the project for linting errors, run
yarn run lint
You can lint with ESLint and Prettier individually as well
yarn run lint:eslint
yarn run lint:prettier
To automatically fix many linting errors, run
yarn run format
You can format using ESLint and Prettier individually as well
yarn run format:eslint
yarn run format:prettier
Testing with Karma
To run the suite of karma tests, run
yarn run test
To run the tests in watch mode (for TDD, for example), run
yarn run test:watch
Demoing with Storybook
To run a local instance of Storybook for your component, run
yarn run storybook
To build a production version of Storybook, run
yarn run storybook:build
Tooling configs
For most of the tools, the configuration is in the package.json
to reduce the amount of files in your project.
If you customize the configuration a lot, you can consider moving them to individual files.
Local Demo with es-dev-server
yarn start
To run a local development server that serves the basic demo located in demo/index.html