Show · SideSheet

SideSheet

An overlay panel that slides out from the edge of the screen, typically used to host secondary action pages.

Demos

How to import

<script lang="ts">
    import { Banner, Button, Form, FormDatePicker, FormRadio, FormRadioGroup, FormSelect, Radio, RadioGroup, SideSheet, TextArea, TypographyText } from '@fibrae/semi-ui-svelte';
</script>

Basic Usage

By default, SideSheet slides from the right side of the screen and could be closed by clicking on the mask.

Use bind:visible to control visibility: the close button, the mask and Esc write false back to visible first, then call onCancel. With a one-way visible and onCancel only, the sheet does not close by itself; set visible to false in the onCancel handler.

Code
<script lang="ts">
    import { Button, SideSheet } from '@fibrae/semi-ui-svelte';

    let visible = $state(false);
</script>

<Button onclick={() => (visible = !visible)}>Open SideSheet</Button>
<SideSheet bind:visible title="滑动侧边栏">
    <p>This is the content of a basic sidesheet.</p>
    <p>Here is more content...</p>
</SideSheet>

Placement

You could use placement to set the position from which SideSheet comes in, supporting one of top, bottom, left, right.



Code
<script lang="ts">
    import { Button, Radio, RadioGroup, SideSheet, type SideSheetProps } from '@fibrae/semi-ui-svelte';

    let visible = $state(false);
    let placement = $state<SideSheetProps['placement']>('right');
</script>

<RadioGroup aria-label="侧边栏位置" onChange={(e) => (placement = e.target.value as SideSheetProps['placement'])} value={placement}>
    <Radio value="right">right</Radio>
    <Radio value="left">left</Radio>
    <Radio value="top">top</Radio>
    <Radio value="bottom">bottom</Radio>
</RadioGroup>
<br />
<br />
<Button onclick={() => (visible = !visible)}>Open SideSheet</Button>
<SideSheet bind:visible {placement} title="滑动侧边栏">
    <p>This is the content of a basic sidesheet.</p>
    <p>Here is more content...</p>
</SideSheet>

Size

You could use size to set the size of SideSheet, supporting one of small(448px), medium(684px), and large(920px). Only takes effects when placement is set to left or right. If the default size does not meet your needs, you can also set the width by setting the width property, for example width={900} / width="800px"



Code
<script lang="ts">
    import { Button, Radio, RadioGroup, SideSheet, type SideSheetProps } from '@fibrae/semi-ui-svelte';

    let visible = $state(false);
    let size = $state<SideSheetProps['size']>('small');
</script>

<RadioGroup aria-label="侧边栏尺寸" onChange={(e) => (size = e.target.value as SideSheetProps['size'])} value={size}>
    <Radio value="small">small</Radio>
    <Radio value="medium">medium</Radio>
    <Radio value="large">large</Radio>
</RadioGroup>
<br />
<br />
<Button onclick={() => (visible = !visible)}>Open SideSheet</Button>
<SideSheet bind:visible {size} title="滑动侧边栏">
    <p>This is the content of a basic sidesheet.</p>
    <p>Here is more content...</p>
</SideSheet>

Non-blocking Workflow

You could set mask={false} to continue working on the area outside SideSheet.

Code
<script lang="ts">
    import { Button, SideSheet, TextArea } from '@fibrae/semi-ui-svelte';

    let visible = $state(false);
    let value = $state('');
</script>

<Button onclick={() => (visible = true)}>Open SideSheet</Button>
<TextArea bind:value placeholder="Please enter something" style="margin-top: 12px" />
<SideSheet bind:visible disableScroll={false} mask={false} title="可操作外部的侧边栏">
    <p>这里是输入的内容:</p>
    <p>{value}</p>
</SideSheet>

Rendered Inside Container

You could use getPopupContainer to render SideSheet in targeted DOM.

Render in this

Code
<script lang="ts">
    import { Button, SideSheet } from '@fibrae/semi-ui-svelte';

    let visible = $state(false);
    let container = $state<HTMLElement>();
</script>

<div bind:this={container} style="height: 320px; overflow: hidden; position: relative; border: 1px solid var(--semi-color-border); border-radius: 2px; padding: 24px; text-align: center; background: var(--semi-color-fill-0)">
    <span>Render in this</span>
    <br />
    <br />
    <Button onclick={() => (visible = true)}>Open SideSheet</Button>
    <SideSheet bind:visible getPopupContainer={() => container!} title="渲染在指定容器内部" width={220}>
        <p>This is the content of a basic sidesheet.</p>
        <p>Here is more content...</p>
    </SideSheet>
</div>

Customized Content

Use the title prop (plain text or a snippet), the footer snippet and other Semi Components to create customized information display layers.

Code
<script lang="ts">
    import { Banner, Button, Form, FormDatePicker, FormRadio, FormRadioGroup, FormSelect, SideSheet, TypographyText } from '@fibrae/semi-ui-svelte';

    let visible = $state(false);
    const createTime = new Date();
    const border = 'border-bottom: 1px solid var(--semi-color-border)';
    const users = [
        { value: '1', label: '曲晨一' },
        { value: '2', label: '夏可曼' },
        { value: '3', label: '曲晨三' },
        { value: '4', label: '蔡妍' },
    ];
</script>

<Button onclick={() => (visible = true)}>More Information</Button>
<SideSheet bind:visible bodyStyle={border} closable={false} headerStyle={border} title="创建资源包">
    {#snippet footer()}
        <div style="display: flex; justify-content: flex-end">
            <Button style="margin-right: 8px">重置</Button>
            <Button theme="solid">提交</Button>
        </div>
    {/snippet}
    <Form>
        <FormDatePicker field="date" initValue={createTime} label={{ text: '创建时间', required: true }} style="width: 272px" type="dateTime" />
        <FormRadioGroup direction="horizontal" field="type" initValue="all" label="目标操作系统">
            <FormRadio value="all">全平台</FormRadio>
            <FormRadio value="ios">iOS</FormRadio>
            <FormRadio value="android">Android</FormRadio>
            <FormRadio value="web">Web</FormRadio>
        </FormRadioGroup>
        <FormRadioGroup direction="horizontal" field="origin" initValue="scm" label="资源包来源">
            <FormRadio value="scm">从SCM上传</FormRadio>
            <FormRadio value="manual">手动上传</FormRadio>
        </FormRadioGroup>
        <Banner bordered fullMode={false} icon={null} type="warning">
            {#snippet description()}
                <TypographyText strong>当前部署环境:线上部署</TypographyText>
                <br />
                <TypographyText>请选择正确的SCM构建产物,防止出现不符合预期的发布操作。</TypographyText>
            {/snippet}
        </Banner>
        <br />
        <FormSelect field="users" initValue={['1', '2', '3', '4']} label={{ text: '创建用户', required: true }} multiple optionList={users} style="width: 560px" />
    </Form>
</SideSheet>

API Reference

Props

PropertyDescriptionTypeDefault
afterVisibleChangeCalled with true right after the commit that shows the sheet, without waiting for the enter animation. Called with false after the leave animation, and once with false if the sheet is unmounted while shown.Type(isVisible: boolean) => void-
bodyStyleStyle of the panel body, as a string.string-
canVerticalSetWidthWhether width applies when placement is top or bottom. By default those sheets span the full width.boolean-
childrenBody of the sheet, written inside the tag.Snippet-
closableWhether the close button in the corner is shown.booleantrue
closeIconSnippet for the icon inside the close button; hide the button with closable set to false.Snippet-
closeOnEscWhether Esc closes the sheet.booleanfalse
disableScrollWhether body scrolling is locked (overflow: hidden on body) while a masked sheet is rendered in document.body.booleantrue
footerSnippet for the footer of the sheet. Nothing is rendered when it is empty.Snippet-
getPopupContainerParent element the sheet is rendered into. A custom container needs position: relative; this changes where the sheet sits in the DOM, not where it is shown.Type() => HTMLElement-
headerStyleStyle of the panel header, as a string.string-
heightHeight, used when placement is top or bottom. A number is in pixels; a string is any valid CSS length. 448 when omitted.number | string-
keepDOMWhether the sheet content stays mounted while closed.booleanfalse
maskWhether the mask is shown. When false the content outside stays operable.booleantrue
maskClosableWhether clicking the mask closes the sheet.booleantrue
maskStyleStyle of the mask, as a string.string-
motionWhether animation is enabled.booleantrue
onCancelCalled when the user closes the sheet with the close button, the mask or Esc, after visible has been written back to false. The argument is the native MouseEvent, or the native KeyboardEvent for Esc.Type(event: MouseEvent | KeyboardEvent) => void-
placementEdge the sheet slides in from.Placement"right"
sizeSize: small is 448px, medium 684px, large 920px. Used only when placement is left or right.'small' | 'medium' | 'large'"small"
styleStyle that lands on the role=dialog element, as a string.string-
titleTitle, plain text or a snippet, which also names the dialog. It is a declared prop, so it never lands on an element as the native title attribute.Snippet | string-
visibleWhether the sheet is visible, used with bind:visible.boolean-
widthWidth, used when placement is left or right. A number is in pixels; a string is any valid CSS length. Decided by size when omitted.number | string-
zIndexz-index of the layer.number1000

Methods

MethodDescriptionType
getRootReturns the outer .semi-sidesheet element inside the portal, or null while nothing is rendered.Type() => HTMLDivElement | null

aria-* attributes and style land on the role="dialog" element (.semi-sidesheet-inner); class and other native attributes and events land on the outermost .semi-sidesheet element inside the portal, which is also what getRoot() returns.

Accessibility

ARIA

  • SideSheet has a dialog role to indicate that it is a pop-up component. The title element (.semi-sidesheet-title) has the heading role and aria-level="2" and names the dialog through aria-labelledby; the header itself has no role. When aria-label is passed it wins and that reference is not generated.
  • Every aria-* attribute and style land on the role="dialog" element; other undeclared props land on the outer element.
  • aria-modal is output only when the dialog is modal. A dialog is modal when it has a mask (mask) and is rendered in the body (judged by the actual container, so the getPopupContainer of ConfigProvider counts). With mask set to false, or a mask confined to a custom container, it is not output.

Keyboard and focus

  • Focus moves into the sheet when it opens.
  • With closeOnEsc set, pressing Esc closes the sheet (off by default).
  • A modal dialog (with a mask, rendered in the body): Tab cycles inside the sheet, the rest of the page is inert, and focus returns to the element focused before it opened when it closes. A sheet with a mask rendered in a custom container does not make the page inert; see the next item.
  • A non-modal dialog (mask set to false, or a mask confined to a custom container): Tab can leave the sheet for the page and the page outside the container stays usable; focus returns on close only if it is still inside the sheet or has fallen to the body, and focus the user has moved elsewhere on the page stays. With a mask confined to a custom container, other content inside that container can still be reached by Tab.

Design Tokens

These are the component's internal Sass variables and cannot be overridden. To customize styles, override the --semi-* CSS variables (see the Design Token page) or write unlayered CSS rules.
Sass variableValueUsage
$animation_duration-sideSheet_mask-show180ms侧边栏打开时-蒙层颜色-动画持续时间
$animation_function-sideSheet_mask-showcubic-bezier(0.25, 0.46, 0.45, 0.94)侧边栏打开时-蒙层颜色-过渡曲线
$animation_delay-sideSheet_mask-show0ms侧边栏打开时-蒙层颜色-延迟时间
$animation_duration-sideSheet_mask-hide180ms侧边栏关闭时-蒙层颜色-动画持续时间
$animation_function-sideSheet_mask-hidecubic-bezier(0.25, 0.46, 0.45, 0.94)侧边栏关闭时-蒙层颜色-过渡曲线
$animation_delay-sideSheet_mask-hide0ms侧边栏关闭时-蒙层颜色-延迟时间
$animation_duration-sideSheet_inner-show180ms侧边栏打开-动画持续时间
$animation_function-sideSheet_inner-showcubic-bezier(0.25, 0.46, 0.45, 0.94)侧边栏打开-过渡曲线
$animation_delay-sideSheet_inner-show0ms侧边栏打开-延迟时间
$animation_duration-sideSheet_inner-hide180ms侧边栏关闭-动画持续时间
$animation_function-sideSheet_inner-hidecubic-bezier(0.25, 0.46, 0.45, 0.94)侧边栏关闭-过渡曲线
$animation_delay-sideSheet_inner-hide0ms侧边栏关闭-延迟时间
$color-sideSheet_mask-bgvar(--semi-color-overlay-bg)侧边栏打开后蒙层颜色
$color-sideSheet-bgvar(--semi-color-bg-2)侧边栏背景颜色
$color-sideSheet_main-textvar(--semi-color-text-0)侧边栏默认文本颜色
$color-sideSheet_header-borderBottomvar(--semi-color-border)侧边栏 header 底部边框颜色
$spacing-sideSheet-margin0侧边栏整体外边距
$spacing-sideSheet_title-margin0侧边栏标题外边距
$spacing-sideSheet_header-padding$spacing-loose侧边栏 header 内边距
$spacing-sideSheet_header-paddingBottom$spacing-base-loose侧边栏 header 底部内边距
$spacing-sideSheet_body-paddingY0侧边栏 body 垂直内边距
$spacing-sideSheet_body-paddingX$spacing-loose侧边栏 body 水平内边距
$spacing-sideSheet_footer-padding$spacing-loose侧边栏 footer 内边距
$width-sideSheet_header-borderBottom0px侧边栏 header 底部边框宽度
$width-sideSheet_size-small448px小尺寸侧边栏宽度
$width-sideSheet_size-medium684px中尺寸侧边栏宽度
$width-sideSheet_size-large920px大尺寸侧边栏宽度
$font-sideSheet_title-fontWeight$font-weight-bold侧边栏标题文本字重
$font-sideSheet_title-fontSize$font-size-header-5侧边栏标题文本字号
$filter-sideSheet_mask-bgnone
$filter-sideSheet-bgnone

FAQ

  • Does SideSheet disable body scrolling automatically? When a SideSheet with a mask is rendered in the body by default (no getPopupContainer), it adds overflow: hidden to the body on open to block scrolling. Set disableScroll to false to allow scrolling; scrolling is not locked when mask is false.