KyuubuProps型
リファレンスの説明と例は英語です。見出しと目次は日本語です。
The component's props: every option of CubeView, a state the parent may keep, and the box's className, style and data-*.
インポート
import type { KyuubuProps } from "@johnmorrisdotca/kyuubu/react";
定義
type KyuubuProps = Omit<CubeViewOptions, "state"> & {
state?: string;
className?: string;
style?: CSSProperties;
ref?: Ref<KyuubuHandle>;
colours?: Partial<Record<CubeFace, string>>;
hint?: CubeMove | readonly CubeMove[] | null;
[data: `data-${string}`]: string | undefined;
};
メンバー
| 名前 | 型 | 説明 |
|---|---|---|
size | number | The cube's side: 2 for a 2×2, 3 for the classic. |
colours (省略可) | Partial<Record<"U" | "R" | "F" | "D" | "L" | "B", string>> | undefined | Colours for the six faces, by the letter a solved face carries. A face left out takes its CSS custom property ( |
plastic (省略可) | string | undefined | The colour of the plastic between stickers and inside the cube. Left out, it is |
theme (省略可) | CubeTheme | undefined | A whole look at once: colours, plastic and the shape of a sticker. |
rounded (省略可) | boolean | undefined | Whether the cube's corners are rounded, like the plastic of a real one: true when left out. The theme's |
locale (省略可) | KyuubuLanguage | undefined | The language of the cube's accessible name: English or Japanese. Left out, it follows the page's |
scale (省略可) | "small" | "medium" | "large" | undefined | How big it is drawn: |
width (省略可) | number | undefined | How wide it is drawn, in pixels, in place of |
interactive (省略可) | boolean | undefined | Whether a person can turn it. A look-only cube still turns when asked ( |
keyboard (省略可) | "focus" | "page" | "none" | undefined | Where the keys are listened for: the cube itself once it has focus (the default), the whole page, or nowhere. |
animateScramble (省略可) | boolean | undefined | Whether |
turnMs (省略可) | number | undefined | How long a quarter turn takes, in milliseconds, when it is made by a key, by notation or from code: 160 when left out. A device that asks for reduced motion gets no animation, whatever this says. |
commitAngle (省略可) | number | undefined | The point of no return of a dragged layer, in degrees: 30 when left out. A layer let go short of it goes back and no move is made; at it or past it, the turn is completed. From 5 to 85. |
yaw (省略可) | number | undefined | How the cube is first seen: turned about its up axis, in degrees. |
pitch (省略可) | number | undefined | How the cube is first seen: tipped towards the viewer, in degrees. |
fill (省略可) | number | undefined | How much of the space the cube fills, 0 to 1. |
onTurn (省略可) | ((move: CubeMove, state: string) => void) | undefined | A turn a person made, with the cube's stickers once it is done. |
onLook (省略可) | ((yaw: number, pitch: number) => void) | undefined | Every time the view is turned, for anything that wants to keep it. |
label (省略可) | string | undefined | What a screen reader calls the cube. Left out, it is "A 3×3 cube" in the cube's language. |
state (省略可) | string | undefined | The stickers the cube starts with. Read when the cube is made, and again whenever it changes to something the cube is not already showing, so a parent that keeps the state and hands it back never makes it jump. |
className (省略可) | string | undefined | |
style (省略可) | CSSProperties | undefined | |
ref (省略可) | Ref<KyuubuHandle> | undefined | |
hint (省略可) | CubeMove | readonly CubeMove[] | null | undefined | Moves to show on the cube, the way the visual guide shows them: the layer lit and an arrow the way to drag it. Null or left out shows nothing. Shown again whenever it changes, and on a cube made afresh. |
例
import type { KyuubuProps } from "@johnmorrisdotca/kyuubu/react";
const value: KyuubuProps = { size: 3, interactive: true, "data-puzzle": "daily" };
console.log(value.size);3出力(このページを作ったときに実行した結果)
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。