API

StaticStyles

動的なスタイルを拒否するスタイルのリスト。css.use() でスタイルを当てるコンポーネント向けです。

type StaticStyles<K extends StyleKey = StyleKey> = StyleList<StaticNamespace<K>>;
export type { StaticStyles };

StaticStyles は関数で作った動的なスタイルを除外します。動的な値は CSS 変数で要素に渡すため、css.use() でクラス名だけを作るコンポーネントには渡せません。

型引数なし

型引数を省くと、どのプロパティでも使えます。動的なスタイルだけが型エラーになります。

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

const styles = css.create({
  base: {
    padding: '8px',
  },
  tinted: {
    color: 'gold',
  },
  sized: (width: number) => ({
    width,
  }),
});

type ChipProps = {
  sx?: css.StaticStyles;
};

export function Chip({ sx }: ChipProps) {
  return <span className={css.use(styles.base, sx)} />;
}
<Chip sx={styles.tinted} />      // ok
<Chip sx={styles.sized(120)} />  // Type error

型引数あり

型引数を指定するとプロパティも絞れます。StaticStyles<'color'> は StyleProps<'color'> から動的なスタイルを除いた型です。

type BadgeProps = {
  sx?: css.StaticStyles<'color' | 'backgroundColor'>;
};

補足

要素の sx に渡すコンポーネントなら、動的なスタイルも扱えます。その場合は StyleProps や WithoutProperties でプロパティを絞れます。

Edit on GitHub