@aurodesignsystem/auro-datetime
v4.0.0
Published
auro-datetime HTML custom element
Readme
Datetime
The <auro-datetime> custom element makes it really easy to add dates to your web app with a simple HTML API.
UI development browser support
For the most up to date information on UI development browser support
Install
$ npm i @aurodesignsystem/auro-datetimeDesign Token CSS Custom Property dependency
The use of any Auro custom element has a dependency on the Auro Design Tokens.
Define dependency in project component
Defining the component dependency within each component that is using the <auro-datetime> component.
import "@aurodesignsystem/auro-datetime";Reference component in HTML
<auro-datetime type="date"></auro-datetime>Use CDN
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.
<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-datetime@latest/+esm"></script>auro-datetime use cases
The <auro-datetime> element should be used in situations where users may:
- A date and/or time is required
API Code Examples
Default auro-datetime
<auro-datetime type="date"></auro-datetime>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.
Start development environment
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.
$ npm run devOpen localhost:8000
Testing
Automated tests are required for every Auro component. See .\test\auro-datetime.test.js for the tests for this component. Run npm run 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.
