@alaskaairux/auro-accordion

    1.3.3 • Public • Published

    auro-accordion

    <auro-accordion> and <auro-accordion-group are HTML custom elements for the purpose of providing collapsible content on a page. <auro-accordion> is usable on its own, but combined with <auro-accordion-group> enables you to auto collapse an expanded section when you select another section.

    UI development browser support

    For the most up to date information on UI development browser support

    Install

    Build Status See it on NPM! License

    $ npm i @alaskaairux/auro-accordion

    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.

    Design Token CSS Custom Property dependency

    The use of any Auro custom element has a dependency on the Auro Design Tokens.

    CSS Custom Property fallbacks

    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.

    Define dependency in project component

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

    import "@alaskaairux/auro-accordion";

    Reference component in HTML

    <auro-accordion id="epIV" expanded>
      <span slot="trigger">Star Wars: A New Hope</span>
      <p>It is a period of civil war. Rebel spaceships, striking from a hidden base, have won their first victory against the evil Galactic Empire.</p>
    </auro-accordion>
    <auro-accordion-group>
      <auro-accordion id="epIV" expanded>
        <span slot="trigger">Star Wars: A New Hope</span>
        <p>It is a period of civil war. Rebel spaceships, striking from a hidden base, have won their first victory against the evil Galactic Empire.</p>
      </auro-accordion>
      <auro-accordion id="epV">
        <span slot="trigger">Star Wars: The Empire Strikes Back</span>
        <p>It is a dark time for the Rebellion. Although the Death Star has been destroyed, Imperial troops have driven the Rebel forces from their hidden base and pursued them across the galaxy.</p>
      </auro-accordion>
    </auro-accordion-group>

    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 @latest in the URL with the version of the asset you want. @latest is NOT aware of any MAJOR releases, use at your own risk.

    <link rel="stylesheet" href="https://unpkg.com/@alaskaairux/design-tokens@latest/dist/tokens/CSSCustomProperties.css" />
    <link rel="stylesheet" href="https://unpkg.com/@alaskaairux/webcorestylesheets@latest/dist/bundled/essentials.css" />
    
    <script src="https://unpkg.com/@alaskaairux/auro-accordion@latest/dist/auro-accordion__bundled.es5.js" nomodule></script>
    <script src="https://unpkg.com/@alaskaairux/auro-accordion@latest/dist/auro-accordion-group__bundled.es5.js" nomodule></script>
    
    <script src="https://unpkg.com/@alaskaairux/auro-accordion@latest/dist/auro-accordion__bundled.js" type="module"></script>
    <script src="https://unpkg.com/@alaskaairux/auro-accordion@latest/dist/auro-accordion-group__bundled.js" type="module"></script>

    polyfills.js

    The polyfills.js is packaged with this component.

    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.

    auro-accordion use cases

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

    • Need one or more collapsible sections

    The auro-accordion-group element should be used with auro-accordion in situations where users may:

    • Need to auto collapse the current open auro-accordion when a new one is clicked in the group

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

    Peer dependency: Please make sure Polymer is installed globally in order to run the Polymer server. See Auro Component Development Details for more information.

    // shell terminal one
    $ npm run dev
    
    // shell terminal two
    $ npm run serve

    Open localhost:3001

    Testing

    Automated tests are required for every Auro component. See .\test\auro-accordion.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.

    Install

    npm i @alaskaairux/auro-accordion

    DownloadsWeekly Downloads

    370

    Version

    1.3.3

    License

    Apache-2.0

    Unpacked Size

    670 kB

    Total Files

    34

    Last publish

    Collaborators

    • avatar