color
functions
get-background-color
@function get-background-color() { ... }
Description
汎用的に使えるbackground colorを取得します。
Parameters
None.
Example
functions.get-background-color($name: light, $type: well)
// ”f7f8fa”
Requires
- [function]
get-brightnesses
get-scrim-background-color
@function get-scrim-background-color() { ... }
Description
モーダルなオーバーレイなどで使うscrimのbackground colorを取得します。
Parameters
None.
Example
functions.get-scrim-background-color()
// ”rgba(0, 0, 0, 0.32)”
get-border-color
@function get-border-color() { ... }
Description
汎用的に使えるborder colorを取得します。
Parameters
None.
Example
functions.get-border-color($brightness: light, $name: high_emphasis)
// ”rgba(57, 60, 65, 0.3)”
Requires
- [function]
get-brightnesses
- [function]
get-emphasises
- [function]
get-semantic-intentions
Used by
- [function]
get-checkbox-border-color
- [function]
get-radio-border-color
get-avatar-border-color
@function get-avatar-border-color() { ... }
Description
avatarのborder colorを取得します。
Parameters
None.
Example
functions.get-avatar-border-color()
// ”rgba(0, 0, 0, 0)”
get-button-border-color
@function get-button-border-color() { ... }
Description
buttonのborder colorを取得します。
Parameters
None.
Example
functions.get-button-border-color($appearance: flat, $color: neutral, $state: enabled)
// ”transparent”
Requires
- [function]
get-button-appearances
- [function]
get-button-colors
- [function]
get-states
- [function]
is-color-code
- [function]
get-button-color
- [function]
get-button-color
- [function]
get-button-color
- [function]
get-button-color
get-checkbox-border-color
@function get-checkbox-border-color() { ... }
Description
checkboxのborder colorを取得します。
Parameters
None.
Example
functions.get-checkbox-border-color($states: (enabled))
//”rgba(57, 60, 65, 0.2)”
Requires
- [function]
get-states
- [function]
get-checkbox-surface-color
- [function]
get-border-color
get-focus-ring-color
この関数は非推奨です focus ringのcolorを取得します。
@function get-focus-ring-color() { ... }
Parameters
None.
Example
functions.get-focus-ring-color($color: neutral)
//”#9297a1”
Requires
- [function]
get-semantic-intentions
- [function]
get-implications
- [function]
get-semantic-intentions
- [function]
get-semantic-color
- [function]
get-implication-color
Used by
- [function]
get-focus-ring-box-shadow
get-interactive-list-border-color
@function get-interactive-list-border-color() { ... }
Description
interactive-listのborder colorを取得します。
Parameters
None.
Example
functions.get-interactive-list-border-color()
// ”rgba(57, 60, 65, 0.2)”
get-interactive-table-border-color
@function get-interactive-table-border-color() { ... }
Description
interactive-tableのborder colorを取得します。
Parameters
None.
Example
functions.get-interactive-table-border-color($element: header)
// “rgba(57, 60, 65, 0.3)”
get-radio-border-color
@function get-radio-border-color() { ... }
Description
radioのborder colorを取得します。
Parameters
None.
Example
functions.get-radio-border-color($states: (enabled))
// ”rgba(57, 60, 65, 0.2)”
Requires
- [function]
get-states
- [function]
get-radio-text-color
- [function]
get-border-color
get-field-border-color
@function get-field-border-color() { ... }
Description
textfieldとselectで共通するfield部分のborder colorを取得します。
Parameters
None.
Example
functions.get-field-border-color(neutral, enabled)
// ”#afb3ba”
Requires
- [function]
get-semantic-intentions
- [function]
get-states
get-button-color
@function get-button-color() { ... }
Description
buttonのbackground colorを取得します。注意事項あり
Parameters
None.
Example
functions.get-button-color(neutral)
// “#585c63”
Requires
- [function]
get-button-colors
Used by
- [function]
get-button-border-color
- [function]
get-button-border-color
- [function]
get-button-border-color
- [function]
get-button-border-color
- [function]
get-button-surface-color
- [function]
get-button-surface-color
- [function]
get-button-surface-color
- [function]
get-button-surface-color
- [function]
get-button-surface-color
- [function]
get-button-text-color
- [function]
get-button-text-color
- [function]
get-button-text-color
- [function]
get-button-text-color
- [function]
get-button-text-color
get-implication-color
@function get-implication-color() { ... }
Description
implication colorを取得します。
Parameters
None.
Example
functions.get-implication-color(interactive, 600)
// ”#1f7acc”
Requires
- [function]
get-implications
Used by
- [function]
get-focus-ring-color
get-background-overlay-color
@function get-background-overlay-color() { ... }
Description
checkbox, radioなどinteractiveな要素にhoverやfocusしたときのoverlay colorを取得します。
Parameters
None.
Example
functions.get-background-overlay-color(light, enabled)
// “rgba(0, 0, 0, 0)”
Requires
- [function]
get-brightnesses
- [function]
get-states
Used by
- [function]
get-button-surface-image
get-image-overlay-color
@function get-image-overlay-color() { ... }
Description
画像にhoverやfocusしたときのoverlay colorを取得します。
Parameters
None.
Example
functions.get-image-overlay-color(enabled)
// “rgba(0, 0, 0, 0)”
Requires
- [function]
get-states
get-primitive-color
@function get-primitive-color() { ... }
Description
汎用的に使えるprimitive colorを取得します。
Parameters
None.
Example
functions.get-primitive-color($name: blue, $level: 600)
// “#1f7acc”
Used by
- [function]
get-button-surface-color
- [function]
get-button-surface-color
- [function]
get-checkbox-surface-color
get-semantic-color
@function get-semantic-color() { ... }
Description
意味が付与されたsemantic colorを取得します。
Parameters
None.
Example
functions.get-semantic-color(informative, 600)
// “#1f7acc”
Requires
- [function]
get-semantic-intentions
Used by
- [function]
get-focus-ring-color
get-surface-color
@function get-surface-color() { ... }
Description
汎用的に使えるsurface colorを取得します。 ページやビューなど最下層でbackground colorを持つ要素の上に乗った、形のあるオブジェクト表面の色がsurface colorです。
Parameters
None.
Example
functions.get-surface-color(light, secondary)
// “#f7f8fa”
Requires
- [function]
get-brightnesses
- [function]
get-priorities
Used by
- [function]
get-button-surface-color
- [function]
get-button-surface-color
- [function]
get-button-surface-color
- [function]
get-button-text-color
- [function]
get-button-text-color
- [function]
get-button-text-color
- [function]
get-button-text-color
get-avatar-surface-color
@function get-avatar-surface-color() { ... }
Description
avatarのsurface colorを取得します。
Parameters
None.
Example
functions.get-avatar-surface-color()
// “#f7f8fa”
get-solid-button-scrim-color
@function get-solid-button-scrim-color() { ... }
Description
solidなappearanceのbuttonのグラデーションを構成するscrimのcolorを取得します。
Parameters
None.
Example
function.get-solid-button-scrim-color(start)
// “rgba(255, 255, 255, 0.25)”
Used by
- [function]
get-button-surface-image
- [function]
get-button-surface-image
get-button-surface-color
@function get-button-surface-color() { ... }
Description
buttonのsurface colorを取得します。
Parameters
None.
Example
function.get-button-surface-color($appearance: flat, $brightness: light, $color: neutral, $state: enabled)
// “#585c63”
Requires
- [function]
get-button-appearances
- [function]
get-brightnesses
- [function]
get-button-colors
- [function]
get-states
- [function]
is-color-code
- [function]
get-button-color
- [function]
get-surface-color
- [function]
get-button-color
- [function]
get-surface-color
- [function]
get-surface-color
- [function]
get-button-color
- [function]
get-button-color
- [function]
get-primitive-color
- [function]
get-hollow-button-surface-opacity
- [function]
get-primitive-color
- [function]
get-hollow-button-surface-opacity
- [function]
get-button-color
Used by
- [function]
get-button-surface-image
get-button-surface-image
@function get-button-surface-image() { ... }
Description
最終的なbutton表面の色を定義したbackground-imageのグラデーションを取得します。 内部でget-button-surface-color()を使っています。
Parameters
None.
Example
function.get-button-surface-image($appearance: flat, $brightness: light, $color: neutral, $own-brightness: light, $state: enabled)
// “linear-gradient(rgba(0, 0, 0, 0), rgba(0, 0, 0, 0)), linear-gradient(#585c63, #585c63)”
Requires
- [function]
get-button-appearances
- [function]
get-brightnesses
- [function]
get-button-colors
- [function]
get-brightnesses
- [function]
get-states
- [function]
is-color-code
- [function]
get-background-overlay-color
- [function]
get-button-background-overlay-brightness
- [function]
get-solid-button-scrim-color
- [function]
get-solid-button-scrim-color
- [function]
get-button-surface-color
get-checkbox-surface-color
@function get-checkbox-surface-color() { ... }
Description
checkboxのsurfaceのcolorを取得します。
Parameters
None.
Example
function.get-checkbox-surface-color(enabled)
// “#ffffff”
Requires
- [function]
get-states
- [function]
get-primitive-color
Used by
- [function]
get-checkbox-border-color
get-header-surface-color
@function get-header-surface-color() { ... }
Description
ヘッダーの背景色を取得します
Parameters
None.
Example
functions.get-header-surface-color($appearance: filled)
// #1f7acc
Requires
- [function]
get-header-appearances
get-progress-indicator-track-surface-color
@function get-progress-indicator-track-surface-color() { ... }
Description
プログレスインジケーターの全体を表すtrack(溝)部分のカラーを取得します
Parameters
None.
Example
functions.get-progress-indicator-track-surface-color()
// #e5f3ff
get-progress-indicator-indicator-surface-color
@function get-progress-indicator-indicator-surface-color() { ... }
Description
プログレスインジケーターの進捗を表すindicator部分のカラーを取得します
Parameters
None.
Example
functions.get-progress-indicator-indicator-surface-color()
// #3e93de
get-skeleton-surface-color
@function get-skeleton-surface-color() { ... }
Description
スケルトン背景の背景色を取得します
Parameters
None.
Example
functions.get-skeleton-surface-color()
// rgba(0, 0, 0, 0.2)
get-field-surface-color
@function get-field-surface-color() { ... }
Description
フィールド要素の背景色を取得します
Parameters
None.
Example
functions.get-field-surface-color(
$color: neutral,
$state: enabled
)
// #f7f8fa
Requires
- [function]
get-semantic-intentions
- [function]
get-states
get-text-color
@function get-text-color() { ... }
Description
テキストカラーを取得します
Parameters
None.
Example
functions.get-text-color($brightness: light, $name: high_emphasis),
// #393c41
Requires
- [function]
get-brightnesses
- [function]
get-emphasises
- [function]
get-semantic-intentions
- [function]
get-implications
Used by
- [function]
get-button-text-color
- [function]
get-checkbox-text-color
- [function]
get-radio-text-color
get-button-text-color
@function get-button-text-color() { ... }
Description
ボタンのテキストカラーを取得します
Parameters
None.
Example
functions.get-button-text-color(
$appearance: flat,
$brightness: light,
$color: neutral,
$state: enabled
),
// #ffffff
Requires
- [function]
get-button-appearances
- [function]
get-brightnesses
- [function]
get-button-colors
- [function]
get-states
- [function]
is-color-code
- [function]
get-surface-color
- [function]
get-button-color
- [function]
get-surface-color
- [function]
get-button-color
- [function]
get-button-color
- [function]
get-text-color
- [function]
get-surface-color
- [function]
get-surface-color
- [function]
get-button-color
- [function]
get-button-color
get-checkbox-text-color
@function get-checkbox-text-color() { ... }
Description
チェックボックスのテキストカラーを取得します
Parameters
None.
Example
functions.get-checkbox-text-color($states: (enabled)),
// #ffffff
Requires
- [function]
get-states
- [function]
get-text-color
get-interactive-list-title-text-color
@function get-interactive-list-title-text-color() { ... }
Description
インタラクティブリストのテキストカラーを取得します
Parameters
None.
Example
functions.get-interactive-list-title-text-color(),
// #393c41
get-interactive-list-edge-element-text-color
@function get-interactive-list-edge-element-text-color() { ... }
Description
インタラクティブリストのleadingおよびtrailingのテキストカラーを取得します
Parameters
None.
Example
functions.interactive-list-edge-element-text-color(enabled)
Requires
- [function]
get-states
get-interactive-list-body-title-text-color
@function get-interactive-list-body-title-text-color() { ... }
Description
インタラクティブリストのタイトルのテキストカラーを取得します
Parameters
None.
Example
functions.interactive-list-body-title-text-color(enabled)
Requires
- [function]
get-states
get-interactive-list-body-description-text-color
@function get-interactive-list-body-description-text-color() { ... }
Description
インタラクティブリストのデスクリプションのテキストカラーを取得します
Parameters
None.
Example
functions.interactive-list-body-description-text-color(enabled)
Requires
- [function]
get-states
get-interactive-table-text-color
@function get-interactive-table-text-color() { ... }
Description
インタラクティブテーブルのテキストカラーを取得します
Parameters
None.
Example
functions.get-interactive-table-text-color()
get-radio-text-color
@function get-radio-text-color() { ... }
Description
ラジオボタンのテキストカラーを取得します
Parameters
None.
Example
functions.get-radio-text-color($states: (enabled)),
// #ffffff
Requires
- [function]
get-states
- [function]
get-text-color
Used by
- [function]
get-radio-border-color
get-field-text-color
@function get-field-text-color() { ... }
Description
フィールド要素のテキストカラーを取得します
Parameters
None.
Example
functions.get-field-text-color(
$color: neutral,
$state: enabled
),
// #393c41
Requires
- [function]
get-semantic-intentions
- [function]
get-states
helper
functions
get-states
@function get-states() { ... }
Description
状態のパターンを配列で取得します
Parameters
None.
Example
functions.get-states()
// enabled, hover, focused, selected, activated, dragged, disabled, mixed,
Used by
- [function]
get-button-border-color
- [function]
get-checkbox-border-color
- [function]
get-radio-border-color
- [function]
get-field-border-color
- [function]
get-background-overlay-color
- [function]
get-image-overlay-color
- [function]
get-button-surface-color
- [function]
get-button-surface-image
- [function]
get-checkbox-surface-color
- [function]
get-field-surface-color
- [function]
get-bottom-navigation-text-color
- [function]
get-button-text-color
- [function]
get-checkbox-text-color
- [function]
get-interactive-list-edge-element-text-color
- [function]
get-interactive-list-body-title-text-color
- [function]
get-interactive-list-body-description-text-color
- [function]
get-radio-text-color
- [function]
get-field-text-color
get-semantic-intentions
@function get-semantic-intentions() { ... }
Description
セマンティックカラーの名称を配列で取得します
Parameters
None.
Example
functions.get-semantic-intentions()
// informative, neutral, positive, notice, negative, attention,
Used by
- [function]
get-border-color
- [function]
get-focus-ring-color
- [function]
get-focus-ring-color
- [function]
get-field-border-color
- [function]
get-semantic-color
- [function]
get-field-surface-color
- [function]
get-text-color
- [function]
get-field-text-color
get-implications
@function get-implications() { ... }
Description
Implicationのタイプを配列で取得します
Parameters
None.
Example
functions.get-implications()
// interactive, favorite, rate
Used by
- [function]
get-focus-ring-color
- [function]
get-implication-color
- [function]
get-text-color
get-densities
@function get-densities() { ... }
Description
行間の密度のタイプを配列で取得します
Parameters
None.
Example
functions.get-densities()
// dense,normal,comfort
Used by
- [function]
get-cell-vertical-spacing-size
- [function]
get-line-height
get-emphasises
@function get-emphasises() { ... }
Description
(テキストなどの)強調を表すタイプを配列で取得します
Parameters
None.
Example
functions.get-emphasises()
// high_emphasis, mid_emphasis, low_emphasis
Used by
- [function]
get-border-color
- [function]
get-text-color
get-sizes
@function get-sizes() { ... }
Description
サイズのタイプを配列で取得します
Parameters
None.
Example
functions.get-sizes()
// xxs, xs, s, m, l, xl, xxl, xxxl
Used by
- [function]
get-border-size
- [function]
get-boundary-size
- [function]
get-gap-size
- [function]
get-avatar-height
- [function]
get-icon-only-button-pict-height
- [function]
get-thumbnail-height
- [function]
get-radius-size
- [function]
get-avatar-radius-size
- [function]
get-spacing-size
- [function]
get-avatar-width
- [function]
get-icon-only-button-pict-width
- [function]
get-thumbnail-width
- [function]
get-line-height
get-transition-value
@function get-transition-value() { ... }
Description
(アニメーションなどにおける)transitionの値を取得します
Parameters
None.
Example
functions.get-transition-value()
// 0
get-priorities
@function get-priorities() { ... }
Description
(カラーの指定などに利用する)優先度のタイプを配列で取得します
Parameters
None.
Example
functions.get-priorities()
// primary, secondary, tertiary
Used by
- [function]
get-surface-color
get-shapes
@function get-shapes() { ... }
Description
シェイプのパターンを配列で取得します
Parameters
None.
Example
functions.get-shapes()
// circle, square
get-brightnesses
@function get-brightnesses() { ... }
Description
明るさ(ライトモード/ダークモード)のタイプを配列で取得します
Parameters
None.
Example
functions.get-brightnesses()
// light, dark
Used by
- [function]
get-background-color
- [function]
get-border-color
- [function]
get-background-overlay-color
- [function]
get-surface-color
- [function]
get-button-surface-color
- [function]
get-button-surface-image
- [function]
get-button-surface-image
- [function]
get-text-color
- [function]
get-button-text-color
get-widths
@function get-widths() { ... }
Description
幅のサイズタイプを配列で取得します
Parameters
None.
Example
functions.get-widths()
// auto, full, half, third
Used by
- [function]
get-width
get-orders
@function get-orders() { ... }
Description
並び順のタイプを配列で取得します
Parameters
None.
Example
functions.get-orders()
// asc, desc
get-positions
@function get-positions() { ... }
Description
positionのパターンを配列で取得します
Parameters
None.
Example
functions.get-positions()
// relative, fixed, sticky
get-elevation-levels
@function get-elevation-levels() { ... }
Description
Elevationのレベルを配列で取得します
Parameters
None.
Example
function.get-elevation-levels
// 0, 1, 2, 3, 4, 5, 6
Used by
- [function]
get-minor-stack-z-index
- [function]
get-elevation-box-shadow
get-layer-levels
@function get-layer-levels() { ... }
Description
Layerのレベルを配列で取得します
Parameters
None.
Example
function.get-layer-levels()
// 1, 2, 3, 4, 5, 6
Used by
- [function]
get-major-stack-z-index
get-minor-stack-types
@function get-minor-stack-types() { ... }
Description
Minor Stackを配列で取得します
Parameters
None.
Example
functions.get-minor-stack-types()
// over, on
Used by
- [function]
get-minor-stack-z-index
get-header-appearances
@function get-header-appearances() { ... }
Description
ヘッダーのアピアランス(表現)タイプを配列で取得します
Parameters
None.
Example
functions.get-header-appearances()
// white, filled, transparent
Used by
- [function]
get-header-surface-color
get-scrim-appearances
@function get-scrim-appearances() { ... }
Description
scrimの表示スタイルを表すタイプを配列で取得します
Parameters
None.
Example
functions.get-scrim-appearances()
// hollow, transparent
get-button-appearances
@function get-button-appearances() { ... }
Description
ボタンのアピアランス(表現)タイプを配列で取得します
Parameters
None.
Example
functions.get-button-appearances()
// flat, outlined, solid, white, transparent, hollow
Used by
- [function]
get-button-border-color
- [function]
get-button-surface-color
- [function]
get-button-surface-image
- [function]
get-button-text-color
- [function]
get-button-border-size
get-button-colors
@function get-button-colors() { ... }
Description
ボタンのカラータイプを配列で取得します
Parameters
None.
Example
functions.get-button-colors()
// neutral, negative, interactive, favorit
Used by
- [function]
get-button-border-color
- [function]
get-button-color
- [function]
get-button-surface-color
- [function]
get-button-surface-image
- [function]
get-button-text-color
get-cell-sizes
@function get-cell-sizes() { ... }
Description
セルのサイズパターンを配列で取得します
Parameters
None.
Example
functions.get-cell-sizes()
// s, m, l
get-avatar-sizes
@function get-avatar-sizes() { ... }
Description
avatarのサイズを配列で取得します
Parameters
None.
Example
functions.get-avatar-sizes()
// xs, s, m, l
get-interactive-table-align-values
@function get-interactive-table-align-values() { ... }
Description
Interactive Tableのアラインタイプを配列で取得します
Parameters
None.
Example
function.get-interactive-table-align-values()
// start, end
get-table-align-values
@function get-table-align-values() { ... }
Description
tableのアラインタイプを配列で取得します
Parameters
None.
Example
functions.get-table-align-values()
// start, end
get-thumbnail-sizes
@function get-thumbnail-sizes() { ... }
Description
thumbnailのサイズパターンを配列で取得します
Parameters
None.
Example
functions.get-thumbnail-sizes()
// s, m, l
get-background-brightness
@function get-background-brightness() { ... }
Description
背景色がlightかdarkかを判定します
Parameters
None.
Example
functions.get-background-brightness(#ffffff)
// light
Requires
- [function]
-compose-contrast-ratio
get-major-stack-range
@function get-major-stack-range() { ... }
Description
Major Stackの範囲を配列で取得します
Parameters
None.
Example
functions.get-major-stack-range()
10000
Used by
- [function]
get-major-stack-z-index
get-major-stack-z-index
@function get-major-stack-z-index() { ... }
Description
Major Stack対応するz-indexを取得します
Parameters
None.
Example
functions.get-major-stack-z-index($layer: 2)
20000
Requires
- [function]
get-layer-levels
- [function]
get-major-stack-range
get-minor-stack-over-range
@function get-minor-stack-over-range() { ... }
Description
ElevationのMinor Stack(over)の範囲を取得します
Parameters
None.
Example
functions.get-minor-stack-over-range()
// 1000
Used by
- [function]
get-minor-stack-z-index
get-minor-stack-on-range
@function get-minor-stack-on-range() { ... }
Description
ElevationのMinor Stack(on)の範囲を取得します
Parameters
None.
Example
functions.get-minor-stack-on-range()
// 10
Used by
- [function]
get-minor-stack-z-index
get-minor-stack-z-index
@function get-minor-stack-z-index() { ... }
Description
マイナースタックを表すz-indexを取得します
Parameters
None.
Example
functions.get-minor-stack-z-index($type: over, $level: 2)
// 2000
Requires
- [function]
get-minor-stack-types
- [function]
get-elevation-levels
- [function]
get-minor-stack-over-range
- [function]
get-minor-stack-on-range
get-button-background-overlay-brightness
@function get-button-background-overlay-brightness() { ... }
Description
ボタンのoverlayタイプを取得します
Parameters
None.
Example
functions.get-button-background-overlay-brightness(flat, light, light)
// light
Used by
- [function]
get-button-surface-image
get-foreground-brightness
@function get-foreground-brightness() { ... }
Description
(未使用?)
Parameters
None.
is-number
@function is-number() { ... }
Description
値が数値かどうかを判定します
Parameters
None.
Example
functions.is-number(3)
// true
is-color-code
@function is-color-code() { ... }
Description
値がカラーコードかどうかを判定します
Parameters
None.
Example
functions.is-color-code(#000000)
// true
Used by
- [function]
get-button-border-color
- [function]
get-button-surface-color
- [function]
get-button-surface-image
- [function]
get-button-text-color
- [function]
get-focus-ring-box-shadow
opacity
functions
get-focus-ring-opacity
この関数は非推奨です Focusが当たっていることを示す枠線の透過率を取得します。
@function get-focus-ring-opacity() { ... }
Parameters
None.
Example
functions.get-focus-ring-opacity()
// 0.15
Used by
- [function]
get-focus-ring-box-shadow
get-disabled-surface-opacity
@function get-disabled-surface-opacity() { ... }
Description
disabledの要素の表面の透過率を取得します
Parameters
None.
Example
functions.get-disabled-surface-opacity()
// 0.38
get-hollow-button-surface-opacity
@function get-hollow-button-surface-opacity() { ... }
Description
Hollow Button(写真やイラスト、色面の上に乗せる際に使うボタン)の表面の透過率を取得します。
Parameters
None.
Example
functions.get-hollow-button-surface-opacity()
// 0.15
Used by
- [function]
get-button-surface-color
- [function]
get-button-surface-color
TODO's
→要確認
outline
functions
get-focus-ring-outline
@function get-focus-ring-outline($brightness: light) { ... }
Description
フォーカスリングのoutlineスタイルを取得します。
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$brightness | outline colorの明暗です。周辺要素との視認性の兼ね合いを考慮して | String | light |
Example
outline: functions.get-focus-ring-outline()
// outline: 0.25rem solid #3e93de
Requires
- [function]
get-focus-ring-size
get-focus-ring-outline-offset
@function get-focus-ring-outline-offset() { ... }
Description
フォーカスリングのoutlineのoffset値を取得します。
Parameters
None.
Example
outline-offset: functions.get-focus-ring-outline-offset()
// outline-offset: 0.125rem
responsive
mixins
mq-boundary
@mixin mq-boundary($name, $level) { ... }
Description
メディアクエリのブレークポイントを設定するmixin
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$name | メディアクエリの方向(up または down) | String | — none |
$level | ブレークポイントのレベル(xxs, xs, s, m, l, xl) | String | — none |
Example
画面幅がm以上の場合のスタイル
.container {
@include mq-boundary(up, m) {
max-width: 960px;
}
}
画面幅がs以下の場合のスタイル
.sidebar {
@include mq-boundary(down, s) {
display: none;
}
}
Requires
- [function]
get-boundary-size
- [function]
get-boundary-size
shadow
mixins
elevation
@mixin elevation($level: 1) { ... }
Description
要素にelevation(影)を適用するmixin
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$level | elevationのレベル(0-6) | Number | 1 |
Example
基本的な使用例
.card {
@include elevation($level: 2);
}
デフォルト値での使用
.card {
@include elevation();
}
Requires
- [function]
get-elevation-box-shadow
functions
get-solid-button-highlight-box-shadow
@function get-solid-button-highlight-box-shadow() { ... }
Description
solid buttonのhighlight表示を行うためのscrim(box-shadow)の値を取得します。
Parameters
None.
Example
functions.get-solid-button-highlight-box-shadow()
// 0px 1px 1px 0px rgba(255, 255, 255, 0.5)
get-solid-button-shadow-box-shadow
@function get-solid-button-shadow-box-shadow() { ... }
Description
solid buttonのshadow表示を行うためのscrim(box-shadow)の値を取得します
Parameters
None.
Example
functions.get-solid-button-shadow-box-shadow()
// 0px -1px 1px 0px rgba(0, 0, 0, 0.1)
get-elevation-box-shadow
@function get-elevation-box-shadow() { ... }
Description
Suerfaceの階層を表すElevationを表現するためのbox-shadowの値を取得します。
Parameters
None.
Example
functions.get-elevation-box-shadow($level: 1)
// 0px -0.1px 1px 0px rgba(0, 0, 0, 0.12), 0px 1px 2px 0px rgba(0, 0, 0, 0.12), 0px 0px 0px 0px rgba(0, 0, 0, 0)
Requires
- [function]
get-elevation-levels
Used by
- [mixin]
elevation
get-focus-ring-box-shadow
この関数は非推奨です。代わりに package/adapter/functions/outline/_focus-ring.scss を参照してください。 要素へのFocusを表すFocus ringを表現するbox-shadowの値を取得します。
@function get-focus-ring-box-shadow() { ... }
Parameters
None.
Example
functions.get-focus-ring-box-shadow()
// 0 0 0 0.25rem rgba(146, 151, 161, 0.15)
Requires
- [function]
get-focus-ring-size
- [function]
get-focus-ring-opacity
- [function]
is-color-code
- [function]
get-focus-ring-color
size
functions
get-border-size
@function get-border-size() { ... }
Description
https://github.com/pepabo/inhouse-tokens/blob/main/tokens/pepper/size/border.yamlの中から引数$levelに応じたborder sizeを取得します。
Parameters
None.
Example
functions.get-border-size(m)
// ”0.0625rem”
Requires
- [function]
get-sizes
get-avatar-border-size
@function get-avatar-border-size() { ... }
Description
基本的なavatarのborder sizeを取得します。
Parameters
None.
Example
get-avatar-border-size()
// ”0”
get-button-border-size
@function get-button-border-size() { ... }
Description
buttonのborder sizeを取得します。
Parameters
None.
Example
functions.get-button-border-size($appearance: flat)
// ”0.0625rem”
Requires
- [function]
get-button-appearances
get-checkbox-border-size
@function get-checkbox-border-size() { ... }
Description
基本的なcheckboxのborder sizeを取得します。
Parameters
None.
Example
functions.get-checkbox-border-size()
// ”0.0625rem”
get-focus-ring-size
@function get-focus-ring-size() { ... }
Description
基本的なfocus ringのborder sizeを取得します。
Parameters
None.
Example
functions.get-focus-ring-size()
// 0.25rem
Used by
- [function]
get-focus-ring-outline
- [function]
get-focus-ring-box-shadow
get-progress-indicator-border-size
@function get-progress-indicator-border-size() { ... }
Description
基本的なindicatorのborder sizeを取得します。
Parameters
None.
Example
functions.get-progress-indicator-border-size()
// 0.25rem
get-radio-border-size
@function get-radio-border-size() { ... }
Description
基本的なradio buttonのborder sizeを取得します。
Parameters
None.
Example
functions.get-radio-border-size()
// 0.0625rem
get-table-border-size
@function get-table-border-size() { ... }
Description
基本的なtableのborder sizeを取得します。
Parameters
None.
Example
functions.get-table-border-size()
// 0.0625rem
get-boundary-sizes
@function get-boundary-sizes() { ... }
Description
画面サイズの$levelのセットを取得します。
Parameters
None.
Example
functions.get-boundary-sizes()
// "xxs, xs, s, m, l, xl”
Used by
- [function]
get-boundary-size-first-key
get-boundary-size-first-key
@function get-boundary-size-first-key() { ... }
Description
画面サイズの$levelのセットの最初のkeyを取得します。
Parameters
None.
Example
functions.get-boundary-size-first-key()
// ”xxs”
Requires
- [function]
get-boundary-sizes
get-boundary-size
@function get-boundary-size() { ... }
Description
画面サイズの$levelに対応するsizeを取得します。
Parameters
None.
Example
functions.get-boundary-size(m)
// ”800px”
Requires
- [function]
get-sizes
Used by
- [mixin]
mq-boundary
- [mixin]
mq-boundary
get-content-sizes
@function get-content-sizes() { ... }
Description
コンテンツの$levelのセットを取得します。
Parameters
None.
Example
functions.get-content-sizes()
// "xs, s, m, l, xl”
Used by
- [function]
get-content-size
get-content-size
@function get-content-size() { ... }
Description
コンテンツの$levelに対応するsizeを取得します。
Parameters
None.
Example
functions.get-content-size(m)
// “960px”
Requires
- [function]
get-content-sizes
get-gap-size
@function get-gap-size() { ... }
Description
$levelに対応するgap sizeを取得します。
Parameters
None.
Example
functions.get-gap-size($level: m)
Requires
- [function]
get-sizes
get-interactive-component-height-keys
@function get-interactive-component-height-keys() { ... }
Description
interactive component heightの$levelのセットを取得します。
Parameters
None.
Example
functions.get-interactive-component-height-keys()
// "xs, s, m, l, xl”
Used by
- [function]
get-interactive-component-height
get-interactive-component-height
@function get-interactive-component-height() { ... }
Description
$levelに対応するinteractive component heightを取得します。
Parameters
None.
Example
functions.get-interactive-component-height($level: m)
// “2.5rem”
Requires
- [function]
get-interactive-component-height-keys
get-avatar-height
@function get-avatar-height() { ... }
Description
$levelに対応するavatar heightを取得します。
Parameters
None.
Example
functions.get-avatar-height($level: m)
// “2.5rem”
Requires
- [function]
get-sizes
get-icon-only-button-pict-height
@function get-icon-only-button-pict-height() { ... }
Description
$levelに対応するアイコンのみのbuttonのpicture heightを取得します。
Parameters
None.
Example
functions.get-icon-only-button-pict-height(m)
// “1.5rem”
Requires
- [function]
get-sizes
get-checkbox-parent-height
@function get-checkbox-parent-height() { ... }
Description
checkboxの外側の枠のheightを取得します。
Parameters
None.
Example
functions.get-checkbox-parent-height()
// “1.5rem”
get-checkbox-child-height
@function get-checkbox-child-height() { ... }
Description
checkboxの内側のheightを取得します。
Parameters
None.
Example
functions.get-checkbox-child-height()
// “1.25rem”
get-header-height
@function get-header-height() { ... }
Description
header heightを取得します。
Parameters
None.
Example
functions.get-header-height()
// “3.5rem”
get-interactive-list-pict-height
@function get-interactive-list-pict-height() { ... }
Description
interactive listのpicture heightを取得します。
Parameters
None.
Example
functions.get-interactive-list-pict-height()
// “1.5rem”
get-interactive-list-edge-element-height
@function get-interactive-list-edge-element-height() { ... }
Description
interactive listのtrailingおよびleadingの高さを取得します
Parameters
None.
Example
functions.get-interactive-list-edge-element-height()
// ”2rem”
get-interactive-table-pict-height
@function get-interactive-table-pict-height() { ... }
Description
interactive tableのpictの高さを取得します
Parameters
None.
Example
functions.get-interactive-table-pict-height()
// 1.5rem
get-circular-progress-indicator-height
@function get-circular-progress-indicator-height() { ... }
Description
circle progress indicatorの高さを取得します
Parameters
None.
Example
functions.get-circular-progress-indicator-height()
// 3
get-radio-parent-height
@function get-radio-parent-height() { ... }
Description
radioをラップする要素の高さを取得します
Parameters
None.
Example
functions.get-radio-parent-height()
// 1.5rem
get-radio-child-background-height
@function get-radio-child-background-height() { ... }
Description
radioの子要素のbackgroundの高さを取得します
Parameters
None.
Example
functions.get-radio-child-background-height()
// 1.25rem
get-radio-child-foreground-height
@function get-radio-child-foreground-height() { ... }
Description
radioの子要素のforegroundの高さを取得します
Parameters
None.
Example
functions.get-radio-child-foreground-height()
// 0.75rem
get-thumbnail-height
@function get-thumbnail-height() { ... }
Description
thumbnailの高さを取得します
Parameters
None.
Example
functions.get-thumbnail-height($level: m)
// 3.5rem
Requires
- [function]
get-sizes
get-radius-size
@function get-radius-size() { ... }
Description
$levelに応じたradiusの値を取得します
Parameters
None.
Example
functions.get-radius-size($level: m)
// 0.25rem
Requires
- [function]
get-sizes
get-avatar-radius-size
@function get-avatar-radius-size() { ... }
Description
$levelに応じたavatarのサイズを取得します
Parameters
None.
Example
functions.get-avatar-radius-size($level: m)
// 1.25rem
Requires
- [function]
get-sizes
get-button-radius-size
@function get-button-radius-size() { ... }
Description
buttonのradiusの値を取得します
Parameters
None.
Example
functions.get-button-radius-size()
// 0.25rem
get-thumbnail-radius-size
@function get-thumbnail-radius-size() { ... }
Description
thumbnailのradiusの値を取得します
Parameters
None.
Example
functions.get-thumbnail-radius-size()
// 0rem
get-sizing-scale-size
@function get-sizing-scale-size() { ... }
Description
$levelに応じたscale(16が基準のscale、remなどで使う)を取得する
Parameters
None.
Example
functions.get-sizing-scale-size()
// 1rem
get-spacing-size
@function get-spacing-size() { ... }
Description
$evelに応じたspacingの値を取得します
Parameters
None.
Requires
- [function]
get-sizes
get-cell-vertical-spacing-size
@function get-cell-vertical-spacing-size() { ... }
Description
cellの垂直方向のspacingの値を取得します
Parameters
None.
Example
functions.get-cell-vertical-spacing-size($density: normal)
// 0.75rem
Requires
- [function]
get-densities
get-interactive-list-spacing-size
@function get-interactive-list-spacing-size() { ... }
Description
interactive listのspacingの値を取得します
Parameters
None.
Example
functions.get-interactive-list-spacing-size()
// 0.5rem
get-width
@function get-width() { ... }
Description
$width(full, half, third, auto)に応じた割合(calc)を取得します
Parameters
None.
Example
functions.get-width($width: third)
// calc(100% / 3)
Requires
- [function]
get-widths
get-avatar-width
@function get-avatar-width() { ... }
Description
$levelに応じたavatarのwidthの値を取得します
Parameters
None.
Example
functions.get-avatar-width($level: m)
// 2.5rem
Requires
- [function]
get-sizes
get-icon-only-button-pict-width
@function get-icon-only-button-pict-width() { ... }
Description
$levelに応じたicon buttonのpictのwidthの値を取得します
Parameters
None.
Example
functions.get-icon-only-button-pict-width($level: m)
// 1.5rem
Requires
- [function]
get-sizes
TODO's
pictの説明を追加する
get-checkbox-parent-width
@function get-checkbox-parent-width() { ... }
Description
checkboxをラップする要素のwidthの値を取得します
Parameters
None.
Example
functions.get-checkbox-parent-width()
// 1.5rem
get-checkbox-child-width
@function get-checkbox-child-width() { ... }
Description
checkboxの子要素のwidthの値を取得します
Parameters
None.
Example
functions.get-checkbox-child-width()
// 1.25rem
get-description-list-leading-width
@function get-description-list-leading-width() { ... }
Description
description listのleading要素のwidthの値を取得します
Parameters
None.
Example
functions.get-description-list-leading-width()
// 3rem
get-interactive-list-pict-width
@function get-interactive-list-pict-width() { ... }
Description
interactive listのpictの値を取得します
Parameters
None.
Example
functions.get-interactive-list-pict-width()
// 1.5rem
TODO's
pictの説明を追加する
get-interactive-list-edge-element-width
@function get-interactive-list-edge-element-width() { ... }
Description
interactive list のleadingおよびtrailing要素のwidthの値を取得します
Parameters
None.
Example
functions.get-interactive-list-edge-element-width()
// 2rem
get-interactive-table-pict-width
@function get-interactive-table-pict-width() { ... }
Description
interactive tableのpictのwidthの値を取得します
Parameters
None.
Example
functions.get-interactive-table-pict-width()
// 1.5rem
TODO's
pictの説明を追加する
get-list-leading-width
@function get-list-leading-width() { ... }
Description
listのleading要素のwidthの値を取得します
Parameters
None.
Example
functions.get-list-leading-width()
// 3rem
get-circular-progress-indicator-width
@function get-circular-progress-indicator-width() { ... }
Description
circular progress indicatorのwidthの値を取得します
Parameters
None.
Example
functions.get-circular-progress-indicator-width()
// 3rem
get-radio-parent-width
@function get-radio-parent-width() { ... }
Description
radioボタンの親要素のwidthの値を取得します
Parameters
None.
Example
functions.get-radio-parent-width()
// 1.5rem
get-radio-child-background-width
@function get-radio-child-background-width() { ... }
Description
radioボタンの子要素のbackgroundのwidthの値を取得します
Parameters
None.
Example
functions.get-radio-child-background-width()
// 1.25rem
get-radio-child-foreground-width
@function get-radio-child-foreground-width() { ... }
Description
radioボタンの子要素のforegroundのwidthの値を取得します
Parameters
None.
Example
functions.get-radio-child-foreground-width()
// 0.75rem
get-thumbnail-width
@function get-thumbnail-width() { ... }
Description
$levelに応じたthumbnailのwidthの値を取得します
Parameters
None.
Example
functions.get-thumbnail-width($level: m)
// 3.5rem
Requires
- [function]
get-sizes
typography
mixins
text
@mixin text($level: m, $density: normal) { ... }
Description
テキストのフォントサイズと行間を設定するmixin
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$level | フォントサイズのレベル(xxs, xs, s, m, l, xl, xxl, xxxl) | String | m |
$density | 行間の密度(dense, normal, comfort) | String | normal |
Example
基本的な使用例
.text {
@include text($level: l, $density: comfort);
}
デフォルト値での使用
.text {
@include text();
}
Requires
- [function]
get-font-size
- [function]
get-line-height
functions
get-font-family
@function get-font-family() { ... }
Description
font-familyを一つ取得します。
Parameters
None.
Example
functions.get-font-family($name: sans-japanese)
// "'Noto Sans JP'”
compose-font-stack
@function compose-font-stack() { ... }
Description
font-familyのセットを取得します。
Parameters
None.
Example
functions.compose-font-stack($name: japanese)
// "'Open Sans', 'Noto Sans JP', apple-system, BlinkMacSystemFont, Roboto, 'Lucida Grande', Helvetica, Arial, sans-serif”
get-font-size-keys
@function get-font-size-keys() { ... }
Description
tokenで定義されているsizeのkeyを取得します
Parameters
None.
Used by
- [function]
get-font-size
get-font-size
@function get-font-size($level: m) { ... }
Description
基本的なfont sizeを取得します。
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$level | フォントサイズのデザイントークン。くわしくは https://github.com/pepabo/inhouse-tokens/blob/main/tokens/pepper/size/font.yaml を参照してください。 | String | m |
Example
functions.get-font-size($level: m)
// 1rem
Requires
- [function]
get-font-size-keys
Used by
- [mixin]
text
- [function]
get-text-style
get-line-height
@function get-line-height() { ... }
Description
基本的なline heightを取得します。
Parameters
None.
Example
functions.get-line-height($level: m, $density: normal)
// 1.5rem
Requires
- [function]
get-densities
- [function]
get-sizes
Used by
- [mixin]
text
- [function]
get-text-style
get-text-style
@function get-text-style() { ... }
Description
font-sizeとline-heightのリストを取得します。 ※ Sassのリスト型として取得されるので、使うことはほぼなさそうです。代わりに text()
の利用を検討してください。
Parameters
None.
Example
functions.get-text-style($level: m, $density: normal)
// (font-size: 1rem, line-height: 1.5rem)
Requires
- [function]
get-font-size
- [function]
get-line-height
General
functions
[private] -compose-contrast-ratio
@function -compose-contrast-ratio() { ... }
Description
二色間のコントラスト比を計算する 参考: https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests
Parameters
None.
Requires
- [function]
-compose-luminance
- [function]
-compose-luminance
Used by
- [function]
get-background-brightness
[private] -compose-luminance
@function -compose-luminance() { ... }
Description
Parameters
None.
Used by
- [function]
-compose-contrast-ratio
- [function]
-compose-contrast-ratio