@k8ordo/ui

ResizablePanels

仕切りをドラッグするか矢印キーで動かして、2枚のパネルの大きさを分けます。

インポート

ts
import { ResizablePanels } from '@k8ordo/ui';

使い方

valueは1枚目が占める割合(%)で、2枚目は残りを取ります。ルートの要素は親いっぱいに広がるので、親に大きさを与えてください。縦に分けるなら高さが要ります。仕切りはフォーカスでき、矢印キーは画面上の向きのとおりに動かします。HomeとEndでminとmaxの端へ移ります。右から左の言語では1枚目が右に付くので、ArrowLeftで広がります。並びは文字の行に沿うので、縦書きの中ではorientation="horizontal"が上下に並びます。

Sidebar

Content

tsx
<div className={styles.frame}>
  <ResizablePanels.Root defaultValue={30}>
    <ResizablePanels.Panel>Sidebar</ResizablePanels.Panel>
    <ResizablePanels.Handle />
    <ResizablePanels.Panel>Content</ResizablePanels.Panel>
  </ResizablePanels.Root>
</div>

上下の分割

orientation="vertical"は2枚を上下に並べます。仕切りは上下の矢印キーで動き、値は上のパネルが高さに占める割合です。

Editor

Terminal

tsx
<div className={styles.frame}>
  <ResizablePanels.Root orientation="vertical">
    <ResizablePanels.Panel>Editor</ResizablePanels.Panel>
    <ResizablePanels.Handle />
    <ResizablePanels.Panel>Terminal</ResizablePanels.Panel>
  </ResizablePanels.Root>
</div>

仕切りの名前

仕切りの値は1枚目の大きさなので、名前も1枚目に合わせます。1枚目に見出しがあればaria-labelledbyで指します。指さなければ、辞書のresizablePanelsHandleを使います。

Files

Preview

tsx
<ResizablePanels.Root defaultValue={30}>
  <ResizablePanels.Panel>
    <h2 id="files-heading">Files</h2>
  </ResizablePanels.Panel>
  <ResizablePanels.Handle aria-labelledby="files-heading" />
  <ResizablePanels.Panel>Preview</ResizablePanels.Panel>
</ResizablePanels.Root>

制御モード

onChangeはドラッグの間も割合を受け取ります。キーボードではstepずつ動きます。

Sidebar: 30%

Sidebar

Content

tsx
const [size, setSize] = useState(30);

<ResizablePanels.Root onChange={setSize} value={size}>
  …
</ResizablePanels.Root>

Props

ResizablePanels.Root

children?
Type: ReactNode
Default: -
defaultValue?
Type: number
Default: 50
max?
Type: number
Default: 90
min?
Type: number
Default: 10
onChange?
Type: (value: number) => void
Default: -
orientation?
Type: 'horizontal'|'vertical'
Default: 'horizontal'
ref?
Type: Ref<HTMLDivElement>
Default: -
step?
Type: number
Default: 5
value?
Type: number
Default: -
PropTypeDefault
children?ReactNode-
defaultValue?number50
max?number90
min?number10
onChange?(value: number) => void-
orientation?'horizontal'|'vertical''horizontal'
ref?Ref<HTMLDivElement>-
step?number5
value?number-

継承する属性(内部で固定するものを除く): HTMLAttributes<HTMLDivElement>

ResizablePanels.Panel

children?
Type: ReactNode
Default: -
ref?
Type: Ref<HTMLDivElement>
Default: -
PropTypeDefault
children?ReactNode-
ref?Ref<HTMLDivElement>-

継承する属性(内部で固定するものを除く): HTMLAttributes<HTMLDivElement>

ResizablePanels.Handle

PropTypeDefault

継承する属性(内部で固定するものを除く): HTMLAttributes<HTMLDivElement>

ラベルやプレースホルダーなど、このコンポーネントが描く文言は、propsで指定しないと文言辞書から読まれます。差し替え方は次を見てください: コンポーネントの文言

k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。