Action Sheet Svelte Component

Action Sheet is a slide-up pane for presenting the user with a set of alternatives for how to proceed with a given task. You can also use action sheets to prompt the user to confirm a potentially dangerous action. The action sheet contains an optional title and one or more buttons, each of which corresponds to an action to take.

Action Sheet Svelte component represents Action Sheet component.

Action Sheet Components

There are following components included:

  • Actions - action sheet element
  • ActionsGroup - action sheet buttons group
  • ActionsButton - action sheet button
  • ActionsLabel - action sheet label

Action Sheet Properties

PropTypeDefaultDescription
<Actions> properties
openedbooleanfalseAllows to open/close Action Sheet and set its initial state
gridbooleanfalseEnables grid buttons layout
convertToPopoverbooleanWhen enabled, action sheet will be converted to Popover on large screens. By default inherits same app parameter value
forceToPopoverbooleanWhen enabled, action sheel will be always converted to Popover. By default inherits same app parameter value
targetHTMLElement
string
HTML element or string CSS selector of target element. Required when converstion to popover is in use
backdropbooleanEnables action sheet backdrop (dark semi transparent layer behind). By default inherits same app parameter value (true)
backdropElstring
object
HTML element or string CSS selector of custom backdrop element
closeByBackdropClickbooleantrueWhen enabled, action sheet will be closed on backdrop click. By default inherits same app parameter value
closeByOutsideClickbooleanfalseWhen enabled, action sheet will be closed on when click outside of it. By default inherits same app parameter value
closeOnEscapebooleanWhen enabled, action sheet will be closed on ESC keyboard key press
<ActionsLabel> properties
boldbooleanfalseDefines whether the label text is bold or not
<ActionsButton> properties
boldbooleanfalseDefines whether the button text is bold or not
closebooleantrueShould Action Sheet be closed on button click or not

Action Sheet Methods

<Actions> methods
.open(animate)Open Action Sheet
.close(animate)Close Action Sheet

Action Sheet Events

EventDescription
<Actions> events
actionsOpenEvent will be triggered when Action Sheet starts its opening animation
actionsOpenedEvent will be triggered after Action Sheet completes its opening animation
actionsCloseEvent will be triggered when Action Sheet starts its closing animation
actionsClosedEvent will be triggered after Action Sheet completes its closing animation

Open And Close Action Sheet

In addition to Action Sheet open()/close() methods, you can open and close it:

Access To Action Sheet Instance

You can access Action Sheet initialized instance by calling .instance() component's method. For example:

<Actions bind:this={component}>...</Actions>

<script>
  let component;

  // to get instance in some method
  component.instance()
</script>

Examples

<Page>
  <Navbar title="Action Sheet" />
  <Block strong>
    <p class="row">
      <!-- One group, open by direct accessing instance .open() method -->
      <Button class="col" raised onClick={() => actionsOneGroup.open()}>One group</Button>
      <!--  Two groups, open by "actionsOpen" attribute -->
      <Button class="col" raised actionsOpen="#actions-two-groups">Two groups</Button>
    </p>
    <p>
      <!-- Actions Grid, open by changing actionGridOpened state property -->
      <Button raised onClick={() => actionGridOpened = true}>Action Grid</Button>
    </p>
  </Block>

  <BlockTitle>Action Sheet To Popover</BlockTitle>
  <Block strong>
    <p bind:this={buttonToPopoverWrapper}>
      Action Sheet can be automatically converted to Popover (for tablets). This button will open Popover on tablets and Action Sheet on phones:
      <Button
        style="display: inline-block"
        class="button-to-popover"
        onClick={openActionsPopover}
      >
        Actions
      </Button>
    </p>
  </Block>

  <!-- One Group -->
  <Actions bind:this={actionsOneGroup}>
    <ActionsGroup>
      <ActionsLabel>Do something</ActionsLabel>
      <ActionsButton bold>Button 1</ActionsButton>
      <ActionsButton>Button 2</ActionsButton>
      <ActionsButton color="red">Cancel</ActionsButton>
    </ActionsGroup>
  </Actions>

  <!-- Two Groups -->
  <Actions id="actions-two-groups">
    <ActionsGroup>
      <ActionsLabel>Do something</ActionsLabel>
      <ActionsButton bold>Button 1</ActionsButton>
      <ActionsButton>Button 2</ActionsButton>
    </ActionsGroup>
    <ActionsGroup>
      <ActionsButton color="red">Cancel</ActionsButton>
    </ActionsGroup>
  </Actions>

  <!-- Grid -->
  <Actions grid={true} opened={actionGridOpened} onActionsClosed={() => actionGridOpened = false}>
    <ActionsGroup>
      <ActionsButton>
        <img slot="media" src="https://cdn.framework7.io/placeholder/people-96x96-1.jpg" width="48"/>
        <span>Button 1</span>
      </ActionsButton>
      <ActionsButton>
        <img slot="media" src="https://cdn.framework7.io/placeholder/people-96x96-2.jpg" width="48"/>
        <span>Button 2</span>
      </ActionsButton>
      <ActionsButton>
        <img slot="media" src="https://cdn.framework7.io/placeholder/people-96x96-3.jpg" width="48"/>
        <span>Button 3</span>
      </ActionsButton>
    </ActionsGroup>
    <ActionsGroup>
      <ActionsButton>
        <img slot="media" src="https://cdn.framework7.io/placeholder/fashion-96x96-4.jpg" width="48"/>
        <span>Button 4</span>
      </ActionsButton>
      <ActionsButton>
        <img slot="media" src="https://cdn.framework7.io/placeholder/fashion-96x96-5.jpg" width="48"/>
        <span>Button 5</span>
      </ActionsButton>
      <ActionsButton>
        <img slot="media" src="https://cdn.framework7.io/placeholder/fashion-96x96-6.jpg" width="48"/>
        <span>Button 6</span>
      </ActionsButton>
    </ActionsGroup>
  </Actions>
</Page>
  

<script>
  import { onDestroy } from 'svelte';
  import { f7, Page, Navbar, Block, BlockTitle, Button, Actions, ActionsGroup, ActionsLabel, ActionsButton } from 'framework7-svelte';

  let actionGridOpened = false;
  let actionsOneGroup;
  let actionsToPopover = null;
  let buttonToPopoverWrapper;

  onDestroy(() => {
    if (actionsToPopover) {
      actionsToPopover.destroy();
    }
  })

  function openActionsPopover() {
    if (!actionsToPopover) {
      actionsToPopover = f7.actions.create({
        buttons: [
          {
            text: 'Do something',
            label: true,
          },
          {
            text: 'Button 1',
            bold: true,
          },
          {
            text: 'Button 2',
          },
          {
            text: 'Cancel',
            color: 'red',
          },
        ],
        // Need to specify popover target
        targetEl: buttonToPopoverWrapper.querySelector('.button-to-popover'),
      });
    }

    // Open
    actionsToPopover.open();
  }

</script>