sp-action-bar

Examples API

Attributes and Properties #

Property Attribute Type Default Description dir dir 'ltr' | 'rtl' 'ltr' flexible flexible boolean false When `flexible` the action bar sizes itself to its content rather than a specific width. open open boolean false variant variant string The variant applies specific styling when set to `sticky` or `fixed`. `variant` attribute is removed when not matching one of the above.

Slots #

Name Description default slot Content to display with the Action Bar

Description #

A <sp-action-bar> delivers a floating action bar that is a convenient way to deliver stateful actions in cases like selection mode. <sp-action-bar> can be deployed in two variants beyond the default: [varient="fixed"] to position the element in relation to the page, and [variant=sticky] to position the content in relation to content that may scroll.

Usage #

See it on NPM! How big is this package in your project? Try it on webcomponents.dev

yarn add @spectrum-web-components/action-bar

Import the side effectful registration of <sp-action-bar> via:

import '@spectrum-web-components/action-bar/sp-action-bar.js';

When looking to leverage the ActionBar base class as a type and/or for extension purposes, do so via:

import { ActionBar } from '@spectrum-web-components/action-bar';

Example #

<sp-action-bar open>
    <sp-checkbox indeterminate>228 Selected</sp-checkbox>
    <sp-action-group quiet>
        <sp-action-button label="Edit">
            <sp-icon-edit slot="icon"></sp-icon-edit>
        </sp-action-button>
        <sp-action-button label="More">
            <sp-icon-more slot="icon"></sp-icon-more>
        </sp-action-button>
    </sp-action-group>
</sp-action-bar>

Variants #

Fixed #

When using [variant="fixed"], the <sp-action-bar> will display by default at the bottom left of the window and can be customized via CSS from the outside.

<h4>Look down and to the left when toggling.</h4>
<sp-action-bar variant="fixed">
    <sp-checkbox indeterminate>228 Selected</sp-checkbox>
</sp-action-bar>
<sp-button
    onclick="javascript:this.previousElementSibling.open = !this.previousElementSibling.open;"
>
    Toggle fixed action bar
</sp-button>

Sticky #

When using [variant="sticky"], be sure you've spent some time touching up on how sticky really works to ensure the most successful delivery of your content.

<section style="position: relative; max-height: 6em; overflow: auto;">
    <h4>Scroll down for toggle button</h4>
    <sp-action-bar variant="sticky" style="top: 0;">
        <sp-checkbox indeterminate>228 Selected</sp-checkbox>
    </sp-action-bar>
    <p>
        Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
        tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
        veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
        commodo consequat. Duis aute irure dolor in reprehenderit in voluptate
        velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint
        occaecat cupidatat non proident, sunt in culpa qui officia deserunt
        mollit anim id est laborum.
    </p>
    <sp-button
        onclick="javascript:this.previousElementSibling.previousElementSibling.open = !this.previousElementSibling.previousElementSibling.open;"
    >
        Toggle sticky action bar
    </sp-button>
</section>