Popover
設定やフィルターなど、ボタンの隣に開く小さなパネル。
popoverに対するWAI-ARIA APGパターンはありません。Popoverはボタンに紐づけられた非モーダルダイアログです。ページは引き続き操作可能で、ユーザーが移動するとポップオーバーは閉じます。
Dimensions
Set the size of the layer.
import { component$, useStyles$ } from '@builder.io/qwik';
import { Popover } from '@leve-ui/popover';
import { LuX } from '@qwikest/icons/lucide';
import styles from './default.css?inline';
export default component$(() => {
useStyles$(styles);
return (
<Popover.Root class="popover-default">
<Popover.Trigger class="popover-default-trigger">Dimensions</Popover.Trigger>
<Popover.Content sideOffset={8} class="popover-default-content">
<Popover.Title class="popover-default-title">Dimensions</Popover.Title>
<Popover.Description class="popover-default-description">
Set the size of the layer.
</Popover.Description>
<label class="popover-default-label">
Width
<input class="popover-default-input" name="width" value="320px" />
</label>
<label class="popover-default-label">
Height
<input class="popover-default-input" name="height" value="240px" />
</label>
<Popover.Close class="popover-default-close" aria-label="Close">
<LuX class="popover-default-icon" aria-hidden="true" />
</Popover.Close>
{/* The library positions the arrow along the edge and sets data-side */}
<Popover.Arrow class="popover-default-arrow" />
</Popover.Content>
</Popover.Root>
);
});.popover-default-trigger {
padding: 8px 14px;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
font: inherit;
font-size: 14px;
font-weight: 500;
color: light-dark(#0f172a, #ffffff);
cursor: pointer;
}
.popover-default-trigger:hover {
background: light-dark(#f1f5f9, #ffffff14);
}
/* The Content is a popover in the top layer; the library sets its position */
.popover-default-content {
box-sizing: border-box;
width: 260px;
padding: 16px;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
color: light-dark(#0f172a, #ffffff);
font-family: inherit;
box-shadow: 0 8px 24px rgb(15 23 42 / 0.18);
overflow: visible;
}
.popover-default-content:focus-visible {
outline: 2px solid #009dfd;
outline-offset: 2px;
}
.popover-default-title {
margin: 0;
font-size: 15px;
font-weight: 600;
}
.popover-default-description {
margin: 4px 0 12px;
font-size: 13px;
color: light-dark(#475569, #c9ddf0);
}
.popover-default-label {
display: grid;
grid-template-columns: 64px 1fr;
align-items: center;
margin-top: 8px;
font-size: 13px;
}
.popover-default-input {
min-width: 0;
padding: 6px 8px;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
font: inherit;
color: inherit;
}
.popover-default-close {
position: absolute;
top: 8px;
right: 8px;
display: inline-flex;
padding: 4px;
border: none;
border-radius: 6px;
background: none;
color: light-dark(#475569, #c9ddf0);
cursor: pointer;
}
.popover-default-close:hover {
background: light-dark(#f1f5f9, #ffffff14);
}
.popover-default-icon {
width: 14px;
height: 14px;
}
/* A rotated square half outside the edge facing the Trigger */
.popover-default-arrow {
width: 10px;
height: 10px;
background: inherit;
border: inherit;
rotate: 45deg;
}
.popover-default-arrow[data-side="bottom"] {
margin-top: -6px;
border-right: none;
border-bottom: none;
}
.popover-default-arrow[data-side="top"] {
margin-bottom: -6px;
border-left: none;
border-top: none;
}
.popover-default-trigger:focus-visible,
.popover-default-input:focus-visible,
.popover-default-close:focus-visible {
outline: 2px solid #009dfd;
outline-offset: 2px;
}インストール#
個別のパッケージをインストールするか、@leve-ui/coreを使用してすべてのコンポーネントを一度に取得します。
pnpm add @leve-ui/popovernpm install @leve-ui/popoveryarn add @leve-ui/popoverbun add @leve-ui/popoverpnpm add @leve-ui/corenpm install @leve-ui/coreyarn add @leve-ui/corebun add @leve-ui/core構造#
import { Popover } from '@leve-ui/popover'; // or '@leve-ui/core'
<Popover.Root>
<Popover.Anchor /> {/* optional */}
<Popover.Trigger />
<Popover.Content>
<Popover.Title />
<Popover.Description />
<Popover.Close />
<Popover.Arrow />
</Popover.Content>
</Popover.Root>
| パーツ | 要素 | 説明 |
|---|---|---|
Popover.Root | <div> | 各パーツをラップし、開閉状態を保持します。 |
Popover.Trigger | <button> | popoverを開閉するボタンです。asを使用して別の要素またはコンポーネントを描画します。 |
Popover.Anchor | <div> | 省略可能。Triggerの代わりにpopoverを隣に配置する要素です。asを使用して別の要素またはコンポーネントを描画します。 |
Popover.Content | <div> | トップレイヤー内のpopover="manual"要素であるパネル。 |
Popover.Arrow | <div> | 任意。CSSで描画される、Triggerを指す矢印。 |
Popover.Title | <h2> | ポップオーバーの名前を示すタイトル。 |
Popover.Description | <p> | ポップオーバーの説明。 |
Popover.Close | <button> | popoverを閉じるボタンです。asを使用して別の要素またはコンポーネントを描画します。 |
Popover.Trigger、Popover.Anchor、またはPopover.Closeのasに渡されるコンポーネントは、id、aria-*、data-*、およびon*$イベントハンドラーを含む受け取ったpropsを単一の要素に展開する必要があります。
Popover.Contentは配置した場所にレンダリングされ、トップレイヤーに表示されるため、祖先要素のoverflow: hiddenやz-indexによって切り取られることはありません。Floating UIを使用してTriggerの隣に配置されます。Contentにside、align、およびオフセットを設定すると、ビューポート内に留まるように反転およびシフトします。
例#
Anchor#
Popover.AnchorはTrigger以外の要素の隣にポップオーバーを配置します。ここでは、フィルターが検索フィールド全体の下に開き、--leve-popover-anchor-widthによってフィールドと同じ幅になります。
Filters
import { component$, type PropsOf, Slot, useStyles$ } from '@builder.io/qwik';
import { Popover } from '@leve-ui/popover';
import { LuSlidersHorizontal } from '@qwikest/icons/lucide';
import styles from './anchor.css?inline';
// Custom components passed to `as` must spread all received props onto one element
const FieldWrapper = component$<PropsOf<'div'>>((props) => (
<div {...props}>
<Slot />
</div>
));
const IconButton = component$<PropsOf<'button'>>(({ type = 'button', ...props }) => (
<button type={type} {...props}>
<Slot />
</button>
));
export default component$(() => {
useStyles$(styles);
return (
<Popover.Root class="popover-anchor">
{/* The Content is placed below the whole field, not only below the button */}
<Popover.Anchor as={FieldWrapper} class="popover-anchor-field">
<input class="popover-anchor-input" aria-label="Search" placeholder="Search" />
<Popover.Trigger as={IconButton} class="popover-anchor-trigger" aria-label="Filters">
<LuSlidersHorizontal class="popover-anchor-icon" aria-hidden="true" />
</Popover.Trigger>
</Popover.Anchor>
<Popover.Content align="start" sideOffset={6} class="popover-anchor-content">
<Popover.Title class="popover-anchor-title">Filters</Popover.Title>
<label class="popover-anchor-option">
<input type="checkbox" name="open" checked /> Open issues
</label>
<label class="popover-anchor-option">
<input type="checkbox" name="mine" /> Assigned to me
</label>
</Popover.Content>
</Popover.Root>
);
});.popover-anchor-field {
display: flex;
align-items: center;
width: 280px;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
font-family: inherit;
}
.popover-anchor-input {
flex: 1;
min-width: 0;
padding: 8px 10px;
border: none;
background: transparent;
font: inherit;
font-size: 14px;
color: light-dark(#0f172a, #ffffff);
}
.popover-anchor-trigger {
display: inline-flex;
margin: 4px;
padding: 6px;
border: none;
border-radius: 6px;
background: none;
color: light-dark(#475569, #c9ddf0);
cursor: pointer;
}
.popover-anchor-trigger:hover,
.popover-anchor-trigger[data-state="open"] {
background: light-dark(#f1f5f9, #ffffff14);
}
.popover-anchor-icon {
width: 16px;
height: 16px;
}
/* --leve-popover-anchor-width is the width of the Anchor */
.popover-anchor-content {
box-sizing: border-box;
width: var(--leve-popover-anchor-width);
padding: 12px;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
color: light-dark(#0f172a, #ffffff);
font-family: inherit;
box-shadow: 0 8px 24px rgb(15 23 42 / 0.18);
}
.popover-anchor-title {
margin: 0 0 8px;
font-size: 13px;
font-weight: 600;
}
.popover-anchor-option {
display: flex;
align-items: center;
gap: 8px;
padding: 4px 0;
font-size: 14px;
}
.popover-anchor-input:focus-visible,
.popover-anchor-trigger:focus-visible,
.popover-anchor-content:focus-visible {
outline: 2px solid #009dfd;
outline-offset: 2px;
}APIリファレンス#
Root#
| Prop | デフォルト | 型 |
|---|---|---|
| ids | – | { trigger?: string; anchor?: string; content?: string; title?: string; description?: string } パーツの要素IDをオーバーライドします。 |
| defaultOpen | false | boolean ポップオーバーが初期状態で開いているかどうか(非制御)。ページの再開時に開きます。 |
| bind:open | – | Signal<boolean> 開閉状態を保持するシグナル(制御)。 |
| onOpenChange$ | – | QRL<(open: boolean) => void> ユーザーの操作によってPopoverが開閉したときに呼び出されます。 |
すべての<div>属性も受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-popover | 常に存在 |
data-state | "open" | "closed" |
Trigger#
| Prop | デフォルト | 型 |
|---|---|---|
| as | 'button' | keyof HTMLElementTagNameMap | Component<any>
|
すべての<button>属性も受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-popover-trigger | 常に存在 |
data-state | "open" | "closed" |
Anchor#
| Prop | デフォルト | 型 |
|---|---|---|
| as | 'div' | keyof HTMLElementTagNameMap | Component<any>
|
すべての<div>属性も受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-popover-anchor | 常に存在 |
Content#
| Prop | デフォルト | 型 |
|---|---|---|
| side | 'bottom' | 'top' | 'right' | 'bottom' | 'left' ポップオーバーを配置するTrigger(またはAnchor)の側。スペースがない場合は反転します。 |
| align | 'center' | 'start' | 'center' | 'end' その側に沿った配置方向。 |
| sideOffset | 0 | number Triggerからの距離(px)。 |
| alignOffset | 0 | number 側に沿ったオフセット(px)。 |
| avoidCollisions | true | boolean ビューポート内に収まるようにポップオーバーを反転およびシフトするかどうか。 |
| collisionPadding | 0 | number 衝突を防ぐ際のビューポート端からのパディング(px)。 |
| arrowPadding | 0 | number 矢印とポップオーバーの角との間のパディング(px)。 |
| closeOnEscape | true | boolean Escapeでポップオーバーを閉じるかどうか。 |
| closeOnOutsideClick | true | boolean ポップオーバー外でのポインターダウンで閉じるかどうか。 |
すべての<div>属性も受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-popover-content | 常に存在 |
data-state | "open" | "closed" |
data-side | 反転後の最終的な配置側:"top" | "right" | "bottom" | "left" |
data-align | "start" | "center" | "end" |
| CSS変数 | 値 |
|---|---|
--leve-popover-anchor-width | Trigger(またはAnchor)の幅 |
--leve-popover-anchor-height | Trigger(またはAnchor)の高さ |
--leve-popover-available-width | ビューポートで利用可能な幅 |
--leve-popover-available-height | ビューポートで利用可能な高さ |
Contentが開いている間、その位置がTriggerに依存するため、インラインのposition、top、leftが設定されます。表示中は:popover-openに一致し、@starting-styleと組み合わせてアニメーションを適用できます。display(例えばflex)は:popover-openにのみ設定してください。Content自体に設定すると、閉じたポップオーバーに対するブラウザのdisplay: noneが上書きされてしまいます。
Arrow#
独自のpropはありません。 すべての<div>属性を受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-popover-arrow | 常に存在 |
data-side | Contentの最終的な配置側 |
Arrowには、Triggerに面する端に沿ったインラインオフセットが設定されます。CSS(回転させた正方形など)や内部のSVGで描画します。
タイトル#
独自のpropはありません。 すべての<h2>属性を受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-popover-title | 常に存在 |
説明#
独自のpropはありません。 すべての<p>属性を受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-popover-description | 常に存在 |
閉じる#
| Prop | デフォルト | 型 |
|---|---|---|
| as | 'button' | keyof HTMLElementTagNameMap | Component<any>
|
すべての<button>属性も受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-popover-close | 常に存在 |
data-state | "open" | "closed" |
アクセシビリティ#
Popover.Contentはrole="dialog"、Popover.Titleを指すaria-labelledby、およびPopover.Descriptionを指すaria-describedbyをレンダリングします。Titleがない場合は、aria-labelで名前を付けます。Popover.Triggerは、aria-haspopup="dialog"、aria-expanded、およびContentを指すaria-controlsをレンダリングします。- ポップオーバーが開くと、フォーカスはその最初のフォーカス可能な要素(またはContent)に移動します。Escapeおよび
Popover.Closeでポップオーバーが閉じ、フォーカスがTriggerに戻ります。 - ポップオーバーの外側をクリックするか、Tabでフォーカスを外に出すとポップオーバーが閉じ、フォーカスはユーザーが移動した場所にとどまります。
Popover.Arrowはaria-hidden="true"によって支援技術から隠されます。
キーボード操作#
| キー | 説明 |
|---|---|
Enter / Space | Trigger上でポップオーバーを開閉します。 |
Tab | ポップオーバー内でフォーカスを移動します。ポップオーバーから離れるとポップオーバーが閉じます。 |
Escape | closeOnEscapeがfalseでない限り、ポップオーバーを閉じてフォーカスをTriggerに戻します。 |