sp-action-bar

open true false
emphasized true false
tools true false

NPM 1.0.1

View Storybook

Try it on webcomponents.dev
Overview API Changelog

Overview

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>
    2 selected
    <sp-action-button slot="buttons" label="Edit">
        <sp-icon-edit slot="icon"></sp-icon-edit>
    </sp-action-button>
    <sp-action-button slot="buttons" label="More">
        <sp-icon-more slot="icon"></sp-icon-more>
    </sp-action-button>
</sp-action-bar>

Emphasized

Use the emphasized attribute to add priority to the information that is delivered within your <sp-action-bar> element:

<sp-action-bar emphasized open>
    2 selected
    <sp-action-button slot="buttons" label="Edit">
        <sp-icon-edit slot="icon"></sp-icon-edit>
    </sp-action-button>
    <sp-action-button slot="buttons" label="More">
        <sp-icon-more slot="icon"></sp-icon-more>
    </sp-action-button>
</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-button
    onclick="javascript:this.nextElementSibling.open = !this.nextElementSibling.open;"
>
    Toggle fixed action bar
</sp-button>
<sp-action-bar variant="fixed">2 selected</sp-action-bar>

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>
    <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.nextElementSibling.open = !this.nextElementSibling.open;"
    >
        Toggle sticky action bar
    </sp-button>
    <sp-action-bar variant="sticky" style="inset-block: 0px">
        2 selected
        <sp-action-button slot="buttons" label="Edit">
            <sp-icon-edit slot="icon"></sp-icon-edit>
        </sp-action-button>
        <sp-action-button slot="buttons" label="More">
            <sp-icon-more slot="icon"></sp-icon-more>
        </sp-action-button>
    </sp-action-bar>
</section>

1.0.1 (2024-11-11)

Note: Version bump only for package @spectrum-web-components/action-bar

1.0.0 (2024-10-31)

Note: Version bump only for package @spectrum-web-components/action-bar

0.49.0 (2024-10-15)

Features

  • add static-color to replace static (#4808) (43cf086)

0.48.1 (2024-10-01)

Note: Version bump only for package @spectrum-web-components/action-bar

0.48.0 (2024-09-17)

Note: Version bump only for package @spectrum-web-components/action-bar

0.47.2 (2024-09-03)

Note: Version bump only for package @spectrum-web-components/action-bar

0.47.1 (2024-08-27)

Note: Version bump only for package @spectrum-web-components/action-bar

0.47.0 (2024-08-20)

Note: Version bump only for package @spectrum-web-components/action-bar

0.46.0 (2024-08-08)

Note: Version bump only for package @spectrum-web-components/action-bar

0.45.0 (2024-07-30)

Note: Version bump only for package @spectrum-web-components/action-bar

0.44.0 (2024-07-15)

Features

  • action-bar: support for action-menus (#3780) (4aff599)

0.43.0 (2024-06-11)

Note: Version bump only for package @spectrum-web-components/action-bar

0.42.5 (2024-05-24)

Note: Version bump only for package @spectrum-web-components/action-bar

0.42.4 (2024-05-14)

Bug Fixes

  • action-bar: include focus-visible polyfilling (#4273) (fd71ca1)
  • styles,theme: add S2 tokens and theme (#4241) (a29e4a2), closes #4232 #4228

0.42.3 (2024-05-01)

Note: Version bump only for package @spectrum-web-components/action-bar

0.42.2 (2024-04-03)

Note: Version bump only for package @spectrum-web-components/action-bar

0.42.1 (2024-04-02)

Note: Version bump only for package @spectrum-web-components/action-bar

0.42.0 (2024-03-19)

Features

  • asset: use core tokens (99e76f4)

0.41.2 (2024-03-05)

Note: Version bump only for package @spectrum-web-components/action-bar

0.41.1 (2024-02-22)

Note: Version bump only for package @spectrum-web-components/action-bar

0.41.0 (2024-02-13)

Note: Version bump only for package @spectrum-web-components/action-bar

0.40.5 (2024-02-05)

Note: Version bump only for package @spectrum-web-components/action-bar

0.40.4 (2024-01-29)

Note: Version bump only for package @spectrum-web-components/action-bar

0.40.3 (2024-01-11)

Note: Version bump only for package @spectrum-web-components/action-bar

0.40.2 (2023-12-18)

Note: Version bump only for package @spectrum-web-components/action-bar

0.40.1 (2023-12-05)

Note: Version bump only for package @spectrum-web-components/action-bar

0.40.0 (2023-11-16)

Note: Version bump only for package @spectrum-web-components/action-bar

0.39.4 (2023-11-02)

Bug Fixes

  • action-bar: allow "close" event to be cancelled (17cf55e)

0.39.3 (2023-10-18)

Note: Version bump only for package @spectrum-web-components/action-bar

0.39.2 (2023-10-13)

Bug Fixes

  • update deps graph, update link docs (#3709) (2deb284)

0.39.1 (2023-10-06)

Note: Version bump only for package @spectrum-web-components/action-bar

0.39.0 (2023-09-25)

Note: Version bump only for package @spectrum-web-components/action-bar

0.38.0 (2023-09-05)

Note: Version bump only for package @spectrum-web-components/action-bar

0.37.0 (2023-08-18)

Note: Version bump only for package @spectrum-web-components/action-bar

0.36.0 (2023-08-18)

Note: Version bump only for package @spectrum-web-components/action-bar

0.35.0 (2023-07-31)

Features

  • action-bar: use core tokens (4e21edf)

0.34.0 (2023-07-11)

Note: Version bump only for package @spectrum-web-components/action-bar

0.33.2 (2023-06-14)

Note: Version bump only for package @spectrum-web-components/action-bar

0.33.0 (2023-06-08)

Note: Version bump only for package @spectrum-web-components/action-bar

0.32.0 (2023-06-01)

Note: Version bump only for package @spectrum-web-components/action-bar

0.31.0 (2023-05-17)

Note: Version bump only for package @spectrum-web-components/action-bar

0.30.0 (2023-05-03)

Bug Fixes

  • correct @element jsDoc listing across library (c97a632)
  • menu: add support for submenu interactions (68399af)
  • propogate open to child sp-popover (ae97677)
  • update to latest spectrum-css packages (a5ca19f)

Features

  • action-bar: create sp-action-bar component to replace sp-actionbar (38004b4)
  • adopt DNA@7 base Spectrum CSS (e08cafd)
  • include all Dev Mode files in side effects (f70817c)
  • shared pkg versions, devmode define warning, registry-conflicts docs (6e49565)
  • use latest exports specification (a7ecf4b)

0.5.17 (2023-04-24)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.16 (2023-04-05)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.15 (2023-03-22)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.14 (2023-03-08)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.13 (2023-02-13)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.12 (2023-02-08)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.11 (2023-01-23)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.10 (2023-01-09)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.9 (2022-12-08)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.8 (2022-11-21)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.7 (2022-11-14)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.6 (2022-10-28)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.5 (2022-10-17)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.4 (2022-10-10)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.3 (2022-09-15)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.2 (2022-09-14)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.1 (2022-08-24)

Note: Version bump only for package @spectrum-web-components/action-bar

0.5.0 (2022-08-09)

Features

  • include all Dev Mode files in side effects (f70817c)

0.4.17 (2022-08-04)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.16 (2022-07-18)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.15 (2022-06-29)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.14 (2022-06-07)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.13 (2022-05-27)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.12 (2022-05-12)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.11 (2022-04-21)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.10 (2022-03-30)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.9 (2022-03-08)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.8 (2022-03-08)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.7 (2022-03-04)

Bug Fixes

  • menu: add support for submenu interactions (68399af)

0.4.6 (2022-02-22)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.5 (2022-02-02)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.4 (2022-01-26)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.3 (2022-01-26)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.2 (2022-01-07)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.1 (2021-12-13)

Note: Version bump only for package @spectrum-web-components/action-bar

0.4.0 (2021-11-08)

Note: Version bump only for package @spectrum-web-components/action-bar

0.3.1 (2021-11-08)

Note: Version bump only for package @spectrum-web-components/action-bar

0.3.0 (2021-11-02)

Features

  • adopt DNA@7 base Spectrum CSS (e08cafd)

0.2.18 (2021-10-12)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.17 (2021-09-20)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.16 (2021-09-13)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.15 (2021-08-24)

Bug Fixes

  • correct @element jsDoc listing across library (c97a632)
  • propogate open to child sp-popover (ae97677)

0.2.14 (2021-08-17)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.13 (2021-08-03)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.12 (2021-07-22)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.11 (2021-07-01)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.10 (2021-06-16)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.9 (2021-06-07)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.8 (2021-05-24)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.7 (2021-05-12)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.6 (2021-04-15)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.5 (2021-04-09)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.4 (2021-03-29)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.3 (2021-03-22)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.2 (2021-03-22)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.1 (2021-03-05)

Note: Version bump only for package @spectrum-web-components/action-bar

0.2.0 (2021-03-04)

Features

  • use latest exports specification (a7ecf4b)

0.1.1 (2021-02-11)

Bug Fixes

  • update to latest spectrum-css packages (a5ca19f)

0.1.0 (2021-02-02)

Features

  • action-bar: create sp-action-bar component to replace sp-actionbar (38004b4)

Attributes and Properties

Property Attribute Type Default Description emphasized emphasized boolean false Deliver the Action Bar with additional visual emphasis. 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

Events

Name Type Description close Event