API

css.varType

★★★★☆ Stable

@property で登録した型付きのカスタムプロパティ。トランジションやアニメーションができます。

export type varType = <const T extends VarType>(rule: T) => CSSVariableKey;
export const varType: varType;

varType()は @property でカスタムプロパティを登録し、ビルド時に埋め込まれたユニークなハッシュであるその名前を返します。登録されたプロパティにはタイプが付けられているため、ブラウザはグラデーションの角度などのトランジションやアニメーションでそれを間接的に計算できます。

Typed Variablesのプレイグラウンドの例を試してみてください。

例

TypeScript
import * as css from '@plumeria/core'

const angle = css.varType({
  syntax: '<angle>',
  initialValue: '0deg',
});

const styles = css.create({
  ring: {
    background: `conic-gradient(from var(${angle}), #d653bb, #2aa4f4, #d653bb)`,
    transition: `${angle} 0.6s ease`,
    ':hover': {
      [angle]: '180deg',
    },
  },
});

オプション

  • syntax は値の型です。'<length>'、'<color>'、'<angle>' などを指定します。'<length> | <percentage>' のように | で複数の型を組み合わせられます。型の後ろの + は空白区切り、# はカンマ区切りのリストです。'*' はすべての値を受け付けます。
  • initialValue: プロパティが設定されるまで持つ値です。すべての構文で必要ですが、'*'を除くすべての構文で必要です。
  • inherits: プロパティが親から継承するかどうか。デフォルトはfalseです。

使い方

返された名前はカスタムプロパティ名です。値を設定するためにキーとして使用し、var() の内部で読み取ります:

const styles = css.create({
  box: {
    [angle]: '45deg',
    transform: `rotate(var(${angle}))`,
  },
  rotate: (value: string) => ({
    [angle]: value,
  }),
});

@propertyはcss.createで使用される名前に対してのみエミットされるため、何も使用しない定義はスタイルシートに追加されません。定義はkeyframesなどの他のモジュールからエクスポートおよびインポートできます。

検証

ブラウザは、initialValueがsyntaxと一致しない@propertyを無視します。スタイルシートが解析できない定義(例:タイプ名が誤っている場合や、別のタイプの初期値など)は、定義の時点でビルドを停止します:

const size = css.varType({
  syntax: '<length>',
  initialValue: 'red',
});

validate-valuesはエディタでも同じ不一致を報告します。また、使用場所によって依存する初期値も報告しますが、ブラウザは警告なしに捨てるため、emやremなどのフォント相対単位、cqwなどのコンテナ単位、var()などを使用しないでください。代わりに16pxなどの絶対値を使用してください。

Edit on GitHub