This package has been deprecated

Author message:

See @alaskaairux/auro-button for latest updates

@alaskaairux/ods-button

Auro-button web component

<ods-button> and <auro-button> are wrapper components for an HTML <button> element containing styling and behavior.

Install

$ npm i @alaskaairux/ods-button

Dependencies

The use of any Auro Component has a dependency on the Auro Design Tokens. Be sure to read through all the install instructions to ensure the best results.

Defining a dependency

Define the component dependency within the project using either the <ods-button> or <auro-button> web components.

import "@alaskaairux/ods-button";

or

import "@alaskaairux/ods-button/dist/auro-button";

Reference web component in HTML

<ods-button>Hello World!</ods-button>

or

<auro-button>Hello World!</auro-button>

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.

NOTE: Be sure to replace :version in the URL with the version of the asset you want. The first fully stable version is v4.4.4.

Using Auro assets

<link rel="stylesheet" href="https://unpkg.com/@alaskaairux/orion-design-tokens@:version/dist/tokens/CSSCustomProperties.css" />
<link rel="stylesheet" href="https://unpkg.com/@alaskaairux/orion-web-core-style-sheets@:version/dist/bundled/essentials.css" />

<script src="https://unpkg.com/@alaskaairux/ods-button@:version/dist/polyfills.js"></script>
<script src="https://unpkg.com/@alaskaairux/ods-button@:version/dist/auro-button__bundled.js"></script>

Using Orion assets

<link rel="stylesheet" href="https://unpkg.com/@alaskaairux/orion-design-tokens@:version/dist/tokens/CSSTokenProperties.css" />
<link rel="stylesheet" href="https://unpkg.com/@alaskaairux/orion-web-core-style-sheets@:version/dist/bundled/baseline.css" />

<script src="https://unpkg.com/@alaskaairux/ods-button@:version/dist/polyfills.js"></script>
<script src="https://unpkg.com/@alaskaairux/ods-button@:version/dist/ods-button__bundled.js"></script>

polyfills.js

The polyfills.js is packaged with this component, but IT IS NOT NEEDED to load a polyfill per component. The polyfills.js will work for all additional components added to the project.

IE11 Support

Displaimer: While these components are supported in IE, there may be issues with loading the web components polyfill. Please consult their documentation when supporting IE11.

Responsive support

<auro-button> is responsive by default. The button will assume 100% of the width of its container for views less than auro_breakpoint--sm.

Beyond that breakpoint <auro-button> will assume the width of the content or a min-width of 8.75rem, which ever is greater.

Only supported with ods-button

If the desired appearance of the <ods-button> is to responsive within a given space, then the use of the responsive attribute is required on the <ods-element>.

If the desired appearance of the <auro-button> is to be placed in the reverse direction of natural content, then the attributes of responsive and reverse are needed on the <auro-button> element.

Multi button support

When the UI requires the use of multiple buttons within the same space, with the use of the Auro Web Core Style Sheets, and the auro_containedButtons .

Light DOM Support

<ods-button-light> and <auro-button-light> are included in this package for light DOM support.

To pass content to the <auro-button-light>, use the content prop.

<ods-button-light content="Default value"></ods-button-light>

or

<auro-button-light content="Default value"></auro-button-light>

Auro Button Properties:

For a full listing of the Auro Button API

Orion Button Properties:

For a full listing of the Orion Button API

API Code Examples

For full API examples, see the ods-button demo page.

Deprecated

During the transition from Orion to Auro, there will be specific actions taken to address a clean transition and proper deprecation of Orion resources.

1. <ods-button> will continue to be supported until an official EOL has been communicated
2. Alternate build solutions are no longer supported and will be removed with next MAJOR release

Contextual component (deprecated)

Only supported with ods-button

A special case scenario for responsiveness. The <ods-button> element is built to handle responsive situations when it is the only element within a block. If the <ods-button> element is used within context of another element, then it's the responsibility of the parent element to dictate the responsiveness of the <ods-button>.

In this scenario, set the context of the element to be true.

<ods-button context="true">Default state; context true</ods-button>

Development

Developers, 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 three different shell sessions. One is for the Gulp tasks, the second is for a series of npm tasks and the last is to run the Polymer server.

// shell terminal one
$ gulp dev

// shell terminal two
$ npm run dev

// shell terminal three
$ npm run serve

Open localhost:3001