クリップボード
stimeo--clipboard
テキストをコピーし、完了をライブリージョンで通知する。
stimeo--clipboard コントローラは、source ターゲットの値(または明示の text 値)をブラウザ標準の navigator.clipboard API でコピーします(追加依存なし)。成功 / 失敗は data-state に反映し、role="status" のライブリージョンで通知します(アイコンのみで伝えません)。完了表示は feedbackDuration 後に自動解除され、stimeo--clipboard:copy イベントが { success, text } を載せて発火します。ライブラリは挙動のみを提供し、見た目はこの Playground が持ちます。
実行中
キーボード操作
| キー | 動作 |
|---|---|
| Enter / Space | コピーボタンを実行(ネイティブボタン)。 |
<%# Markup for the clipboard (copy & completion feedback) demo.
Copies via navigator.clipboard and announces completion in a role="status" live
region. For localization the completion messages are passed via the copied-label /
error-label Values. The look per data-state (idle / copied / error) lives in demo.css. %>
<div
class="clipboard"
data-controller="stimeo--clipboard"
data-stimeo--clipboard-feedback-duration-value="2000"
data-stimeo--clipboard-copied-label-value="<%= t('components.clipboard.demo.copied') %>"
data-stimeo--clipboard-error-label-value="<%= t('components.clipboard.demo.error') %>">
<input
class="clipboard__source"
type="text"
readonly
aria-label="<%= t('components.clipboard.demo.source_label') %>"
value="https://stimeo.example/share/abc123"
data-stimeo--clipboard-target="source">
<button
class="clipboard__button"
type="button"
data-stimeo--clipboard-target="button"
data-action="click->stimeo--clipboard#copy">
<%= t("components.clipboard.demo.button") %>
</button>
<span
class="clipboard__feedback"
role="status"
aria-live="polite"
data-stimeo--clipboard-target="feedback"></span>
</div>
/*
* Presentation-only styles for the clipboard demo.
* Success / failure styling switches on the data-state the library sets on the
* controller element.
*/
.clipboard {
display: flex;
align-items: center;
gap: 0.5rem;
flex-wrap: wrap;
max-width: 32rem;
}
.clipboard__source {
flex: 1 1 16rem;
padding: 0.5rem 0.75rem;
border: 1px solid var(--border-strong);
border-radius: 0.375rem;
font: inherit;
color: var(--fg);
background: var(--surface-subtle);
}
.clipboard__button {
padding: 0.5rem 0.9rem;
border: 1px solid var(--accent);
border-radius: 0.375rem;
background: var(--accent);
color: var(--white);
font: inherit;
font-weight: 600;
cursor: pointer;
}
.clipboard[data-state="copied"] .clipboard__button {
background: var(--leaf-500);
border-color: var(--leaf-500);
}
.clipboard[data-state="error"] .clipboard__button {
background: var(--danger-500);
border-color: var(--danger-500);
}
.clipboard__feedback {
flex-basis: 100%;
min-height: 1.25rem;
font-size: 0.875rem;
color: var(--leaf-500);
}
.clipboard[data-state="error"] .clipboard__feedback {
color: var(--danger-500);
}
// Consumer-side JS for the clipboard demo (optional).
// The library fires stimeo--clipboard:copy on every copy attempt with
// detail { success, text }. The consumer subscribes to add its own behavior
// (analytics, a toast, etc.) — here just a simple log.
document.addEventListener("stimeo--clipboard:copy", (event) => {
const { success, text } = event.detail;
console.log(`[clipboard] success=${success} text=${text}`);
});
これらのスタイルは共通のデザイントークン(ライト/ダーク両対応)を使います。 共通スタイルも一緒にコピーし、ルート要素の data-theme を切り替えればダークになります。
このコンポーネントを動かすために HTML へ記述する data-* 属性です。ルート要素に下の data-controller を付け、その内側に各 target / value / action を配置します。
ルート要素に付与
data-controller="stimeo--clipboard"
ターゲット
| 名前 | 説明 | 属性 |
|---|---|---|
source
|
明示的な text 値がないときにコピー元となる、値またはテキストを保持する要素。 | data-stimeo--clipboard-target="source" |
button
必須
|
コピー操作を起動するボタン。 | data-stimeo--clipboard-target="button" |
feedback
必須
|
コピー成功・失敗のラベルを読み上げるライブリージョン(role="status")。 |
data-stimeo--clipboard-target="feedback" |
値(Values)
| 名前 | 説明 | 属性 |
|---|---|---|
text
|
コピーするテキストを明示指定する。空(既定)の場合は source ターゲットの値またはテキストを使う。 | data-stimeo--clipboard-text-value |
feedbackDuration
|
完了通知が自動消去され idle に戻るまでのミリ秒(既定 2000)。0 で自動リセットを無効化。 | data-stimeo--clipboard-feedback-duration-value |
copiedLabel
|
コピー成功時にフィードバック領域へ表示するラベル(既定 "Copied")。 | data-stimeo--clipboard-copied-label-value |
errorLabel
|
コピー失敗時にフィードバック領域へ表示するラベル(既定 "Copy failed")。 | data-stimeo--clipboard-error-label-value |
アクション
| 名前 | 説明 | アクション |
|---|---|---|
copy
|
解決したテキストをクリップボードへコピーし、結果を data-state に反映してフィードバックを表示する。 |
stimeo--clipboard#copy |
イベント
| 名前 | 説明 | イベント |
|---|---|---|
copy
|
コピー試行ごと(失敗時も含む)に発火。detail に { success, text } を載せる。 |
stimeo--clipboard:copy |
状態フック
ライブラリが操作するのはこれらの ARIA / data 属性、カスタムプロパティだけです。見た目は利用側 CSS がこれらに反応して作ります([aria-selected] / [aria-expanded] / var(--stimeo--…) などのセレクタでフックします)。
| フック | 対象 | 意味 |
|---|---|---|
data-state |
ルート要素 | "idle" / "copied" / "error"。 |
テキスト |
feedback | 完了 / 失敗メッセージ(ライブリージョン)。 |