API

css.positionTry

★★★★☆ Stable

アンカー配置で使う、名前付きの @position-try フォールバック。

export type positionTry = <const T extends PositionTry>(rule: T) => CSSVariableKey;
export const positionTry: positionTry;

positionTry()は @position-try ルールを作成し、その名前を返します。このルールは、アランカー位置付けされた要素のフォールバック位置を記述し、要素がその位置に収まらないときに positionTryFallbacks プロパティを通じてそれを使用します。このルールは、それを使用するスタイルに隣接して定義され、グローバルなスタイルシートに記述されるのではなく、名前で参照されます。

Anchor Fallbacksプレイグラウンド例を試してみてください。

要素を配置しているプロパティのみが許可されます:

  • positionAnchorとpositionArea
  • インサート:inset、top、left、insetInline、その他のインサートプロパティ
  • マージン:marginとその長手
  • サイズ:width、height、inlineSize、blockSizeとそのminとmaxの形式
  • セルフアライメント:alignSelf、justifySelf、placeSelf

その他のプロパティはタイプエラーであり、no-unknown-css-propertiesはエディタでそれを報告します。

例

トリガーの下にメニューが開きます。下にスペースがない場合は、より短い高さでトリガーの右側に移動します:

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

const right = css.positionTry({
  positionArea: 'right',
  maxHeight: 200,
  marginTop: 0,
  marginLeft: 8,
});

const styles = css.create({
  menu: {
    position: 'absolute',
    positionAnchor: '--trigger',
    positionArea: 'bottom',
    maxHeight: 320,
    marginTop: 8,
    overflow: 'auto',
    positionTryFallbacks: right,
  },
});

反対側に移動することはすでにキーワードでカバーされています:positionTryFallbacks: 'flip-block'はメニューをトリガーの上の位置に移動し、マージンも変更します。サイズやレイアウトなど、サイドよりもフォールバックが変化する場合はpositionTry()を使用してください。名前とキーワードは一緒にリストし、ブラウザは順に試みます。

別のファイルで使う

定義は他のどの値と同様に、エクスポートしてインポートできます。

fallbacks.ts
import * as css from '@plumeria/core'

export const right = css.positionTry({
  positionArea: 'right',
  maxHeight: 200,
  marginTop: 0,
  marginLeft: 8,
});
Menu.tsx
import * as css from '@plumeria/core'
import { right } from './fallbacks'

const styles = css.create({
  menu: {
    positionTryFallbacks: right,
  },
});

@position-tryルールは、その名前がcss.createで使用される場合にのみエミットされるため、何も使用しない定義はスタイルシートに追加されません。

Edit on GitHub