Skip to content

Commit

Permalink
chore(release): 2.0.3 [skip ci]
Browse files Browse the repository at this point in the history
## [2.0.3](v2.0.2...v2.0.3) (2023-06-23)

### Bug Fixes

* **define:** registerComponent no longer requires className as param [#133](#133) ([717d2d9](717d2d9))
* **dropdown:** use latest version of dropdown ([f583ede](f583ede))
  • Loading branch information
semantic-release-bot committed Jun 23, 2023
1 parent 1953714 commit b5851dc
Show file tree
Hide file tree
Showing 3 changed files with 81 additions and 73 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Semantic Release Automated Changelog

## [2.0.3](https://github.com/AlaskaAirlines/auro-datepicker/compare/v2.0.2...v2.0.3) (2023-06-23)


### Bug Fixes

* **define:** registerComponent no longer requires className as param [#133](https://github.com/AlaskaAirlines/auro-datepicker/issues/133) ([717d2d9](https://github.com/AlaskaAirlines/auro-datepicker/commit/717d2d974190d88e5ed8c6a5ea7055a102475512))
* **dropdown:** use latest version of dropdown ([f583ede](https://github.com/AlaskaAirlines/auro-datepicker/commit/f583edeafe953bf8c1518ed9aab85ddae5308d17))

## [2.0.2](https://github.com/AlaskaAirlines/auro-datepicker/compare/v2.0.1...v2.0.2) (2023-05-23)


Expand Down
144 changes: 72 additions & 72 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<!--
The README.md file is a compiled document. No edits should be made directly to this file.
README.md is created by running `npm run build:markdownDocs`.
This file is generated based on a template fetched from
`https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README.md`
and copied to `./componentDocs/README.md` each time the the docs are compiled.
The following sections are editable by making changes to the following files:
| SECTION | DESCRIPTION | FILE LOCATION |
|------------------------|---------------------------------------------------|-------------------------------------|
| Description | Description of the component | `./docs/partials/description.md` |
| Use Cases | Examples for when to use this component | `./docs/partials/useCases.md` |
| Additional Information | For use to add any component specific information | `./docs/partials/readmeAddlInfo.md` |
| Component Example Code | HTML sample code of the components use | `./apiExamples/basic.html` |
<!--
The README.md file is a compiled document. No edits should be made directly to this file.
README.md is created by running `npm run build:markdownDocs`.
This file is generated based on a template fetched from
`https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README.md`
and copied to `./componentDocs/README.md` each time the the docs are compiled.
The following sections are editable by making changes to the following files:
| SECTION | DESCRIPTION | FILE LOCATION |
|------------------------|---------------------------------------------------|-------------------------------------|
| Description | Description of the component | `./docs/partials/description.md` |
| Use Cases | Examples for when to use this component | `./docs/partials/useCases.md` |
| Additional Information | For use to add any component specific information | `./docs/partials/readmeAddlInfo.md` |
| Component Example Code | HTML sample code of the components use | `./apiExamples/basic.html` |
-->

# Datepicker
Expand All @@ -27,24 +27,24 @@ For the most up to date information on [UI development browser support](https://

## Install

[![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-datepicker/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-datepicker/actions/workflows/testPublish.yml)
[![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-datepicker?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-datepicker)
[![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-datepicker?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
[![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/@aurodesignsystem/auro-datepicker?style=for-the-badge)](https://snyk.io/test/npm/@aurodesignsystem/auro-datepicker?tab=issues)

```shell
$ npm i @aurodesignsystem/auro-datepicker
```

[![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-datepicker/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-datepicker/actions/workflows/testPublish.yml)
[![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-datepicker?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-datepicker)
[![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-datepicker?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
[![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/@aurodesignsystem/auro-datepicker?style=for-the-badge)](https://snyk.io/test/npm/@aurodesignsystem/auro-datepicker?tab=issues)

```shell
$ npm i @aurodesignsystem/auro-datepicker
```

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](https://stackoverflow.com/questions/18875674/whats-the-difference-between-dependencies-devdependencies-and-peerdependencies) answer.

### Peer dependencies

The following Auro peer dependencies must be included.

```shell
$ npm i alaskaairux/design-tokens
$ npm i @aurodesignsystem/webcorestylesheets
### Peer dependencies

The following Auro peer dependencies must be included.

```shell
$ npm i alaskaairux/design-tokens
$ npm i @aurodesignsystem/webcorestylesheets
```

### Design Token CSS Custom Property dependency
Expand All @@ -53,24 +53,24 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](

### CSS Custom Property fallbacks

[CSS custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) are [not supported](https://auro.alaskaair.com/support/custom-properties) in older browsers. For this, fallback properties are pre-generated and included with the npm.

[CSS custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) are [not supported](https://auro.alaskaair.com/support/custom-properties) 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.

### Define dependency in project component

Defining the component dependency within each component that is using the `<auro-datepicker>` component.

```js
import "@aurodesignsystem/auro-datepicker";
```js
import "@aurodesignsystem/auro-datepicker";
```

**Reference component in HTML**

```html
<auro-datepicker>
<span slot="fromLabel">Choose a date</span>
<span slot="mobileDateLabel">Choose a date</span>
```html
<auro-datepicker>
<span slot="fromLabel">Choose a date</span>
<span slot="mobileDateLabel">Choose a date</span>
</auro-datepicker>
```

Expand All @@ -80,60 +80,60 @@ In cases where the project is not able to process JS assets, there are pre-proce

### Bundle example code

```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/tokens/CSSCustomProperties.css" />
```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/tokens/CSSCustomProperties.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/bundled/essentials.css" />
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-datepicker@latest/dist/auro-datepicker__bundled.js" type="module"></script>
<script src="https://cdn.jsdelivr.net/@aurodesignsystem/auro-datepicker@latest/dist/auro-datepicker__bundled.js" type="module"></script>
```

### Peer dependencies

The following Auro peer dependencies must be included.

```html
### Peer dependencies

The following Auro peer dependencies must be included.

```html
<script src="https://cdn.jsdelivr.net/npm/@alaskaairux/auro-icon@latest/dist/auro-icon__bundled.js" type="module"></script>
```

## auro-datepicker use cases

The `<auro-datepicker>` element should be used in situations where users may:

* select a single date
The `<auro-datepicker>` element should be used in situations where users may:

* select a single date
* select a pair of dates which identify a calendar range

## API Code Examples

### Default auro-datepicker

```html
<auro-datepicker>
<span slot="fromLabel">Choose a date</span>
<span slot="mobileDateLabel">Choose a date</span>
```html
<auro-datepicker>
<span slot="fromLabel">Choose a date</span>
<span slot="mobileDateLabel">Choose a date</span>
</auro-datepicker>
```

## 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.

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](https://auro.alaskaair.com/contributing) 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**.

```shell
$ npm run dev
```

Open [localhost:8000](http://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
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](http://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
```

### API generation
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"================================================================================"
],
"name": "@aurodesignsystem/auro-datepicker",
"version": "2.0.2",
"version": "2.0.3",
"description": "auro-datepicker HTML custom element",
"repository": {
"type": "git",
Expand Down

0 comments on commit b5851dc

Please sign in to comment.