インラインコード
文の中に置くコードです。まわりのテキストと同じ大きさで、コード用の書体を使い、薄い塗りの上または塗りなしで描きます。テキストであり、コントロールではありません。
- カテゴリ
- コミュニケーション
- トークン
comp.inline-code- レベル
- 基礎
- Web
tanrei-codeschedule - SwiftUI
TanreiInlineCoderadio_button_unchecked - Jetpack Compose
TanreiInlineCoderadio_button_unchecked - Flutter
TanreiInlineCoderadio_button_unchecked - React Native
InlineCoderadio_button_unchecked
生成元 docs/status/status.json, specs/inline-code.spec.json
文の中、見出しの中、プレーン
package.json と同じフォルダーで
npm install を実行し、
npm run dev -- --port 4000 でサーバーを起動します。
グループに size を設定する
Plain：comp.button.container.shape
インラインコードは、文の中でコード上のものを指すために使います。コマンド、プロパティ、ファイル、値などです。読んでコピーするための複数行のコードはコードブロックです。押すキーはキーボードショートカットで、こちらは修飾キーの名前を読み上げます。
Web では、インラインコードは要素ではなく、プロダクト側の code 要素に付けるクラスです。テキストは文書の中にあるので、スクリプトが動く前から、検索、ページ内検索、コピーができます。.tanrei-prose の中にあって pre の中にない code は、クラスがなくても同じように描かれます。Markdown から生成した HTML には何も足す必要がありません。
SwiftUI、Compose、Flutter、React Native は計画中です。このページの冒頭で各プラットフォームに添えた名前は仕様が定めたもので、まだ提供していません。
<link rel="stylesheet" href="@tanrei/web/tokens.css" />
<link rel="stylesheet" href="@tanrei/web/code.css" />
<!-- Tonal：既定です。 -->
<p>まず <code class="tanrei-code" translate="no" spellcheck="false">npm install</code> を実行します。</p>
<!-- Plain：書体だけを変え、色はまわりのテキストと同じです。 -->
<code class="tanrei-code" data-variant="plain">comp.button.container.shape</code>
<!-- 祖先が、中にあるすべてのコードのバリアントを決めます。 -->
<table data-tanrei-code="plain">
<tr><td><code class="tanrei-code">variant</code></td><td><code class="tanrei-code">filled</code></td></tr>
</table>import '@tanrei/web/code.css';
<p>まず <code className="tanrei-code" translate="no" spellCheck={false}>npm install</code> を実行します。</p>| プロパティ | Web での書き方 |
|---|---|
text |
要素の内容 |
variant: tonal |
data-variant="tonal" |
variant: plain |
data-variant="plain" |
variant: auto（既定） |
属性なし。data-tanrei-code="plain" または "tonal" を持つ最も近い祖先が決め、祖先がなければ Tonal です |
折り返しても、それぞれの断片が塗りを保つ
トークン tanrei.comp.navigation-drawer.item.selected.hovered.state-layer.color はこの行より長いので、行の終わりで折り返します。切り詰めることはありません。
リンクの中、強調の中、コードだけの列
Button のリファレンスを参照してください。ダイアログを閉じる唯一の手段に disabled を設定してはいけません。
プロパティ既定値
variantfilledsizemediumインラインコードには固有のサイズがありません。フォントサイズは、まわりのテキストのサイズに 1 つの比率（comp.inline-code.label.scale）を掛けた値です。この比率が、コード用の書体と本文の書体の見た目の大きさをそろえます。本文の 14 の横では 13 になり、見出しの中では見出しのサイズに従います。
行を高くすることはありません。塗りの高さはコード用の書体のテキストボックスと同じで、上下にパディングはありません。
コードは行と一緒に折り返します。まず空白で折り返します。空白のない部分が行より長いときは、文字の間で折り返します。ハイフンは足しません。ハイフンを足すとコードが変わってしまうからです。切り詰めることも、スクロールすることもありません。
リンクの中ではリンクの色になり、リンクの下線がコードの下にも引かれます。強調（strong）の中では太さが 1 段階太くなります。斜体にはなりません。
右から左に書く文の中でも、コードは独立した左から右の並びとして配置します。
構成要素
| パーツ | 説明 |
|---|---|
1 container · 任意 | The fill behind the text in the tonal form: as tall as the code face's own text box, with small corners and a little room at each end of every piece of the run. Decorative; the plain form has none. |
2 label | The code: its characters exactly as given, in the code face. |
3 outline · 任意 | An edge around the fill, where a design system gives it a width. The default system draws none. |
プロパティ
| プロパティ | 型 | 既定値 | 説明 |
|---|---|---|---|
text | string | "" | The code: the characters exactly as they are to be read and copied ("npm install", "comp.button.container.shape"). Spaces inside it are kept. |
variant | auto | tonal | plain | "auto" | How the run is set apart. tonal: the code face on a faint fill. plain: the code face alone, in the color of the text around it, for a column or a list whose every entry is code and for text on a colored container. auto, the default, takes what the nearest ancestor chooses for the inline code inside it, and tonal where none does. |
状態
振る舞い
EARS 記法による要件です。各プラットフォームの実装は、この ID に対応するテストで検証されます。要件の原文は仕様ファイルのものをそのまま掲載しています。
| ID | 要件 |
|---|---|
ICD-1 | THE inline code SHALL set its text in the family, the weight and the letter spacing of comp.inline-code.label.typescale, at the font size of the text it sits in multiplied by comp.inline-code.label.scale — whatever that text is: a paragraph, a heading of any level, a lead paragraph, a caption, a label, a table cell — and SHALL NOT take the font size or the line height of the code role itself. |
ICD-2 | THE inline code SHALL sit on the baseline of the text it is part of, as a part of that text's line, and SHALL NOT make that line taller or change the distance between lines (PRS-17); its fill, where it has one, SHALL be as tall as the code face's own text box (from its ascent to its descent at the drawn size) and SHALL NOT be padded above or below. |
ICD-3 | WHILE the inline code is drawn tonal (ICD-5) THE inline code SHALL draw behind its text a fill of comp.inline-code.container.color with corners comp.inline-code.container.shape eased by sys.shape.corner-smoothing, extend that fill by comp.inline-code.container.padding-inline before the first and after the last character, draw its text in comp.inline-code.label.color, and, where comp.inline-code.outline.width is above 0, draw an edge of that width in comp.inline-code.outline.color inside the fill; it SHALL draw no elevation. |
ICD-4 | WHILE the inline code is drawn plain (ICD-5) THE inline code SHALL draw no fill, no edge and no padding, and SHALL draw its text in the color of the text it sits in, so that it reads on any container that text reads on. |
ICD-5 | WHILE variant is tonal or plain THE inline code SHALL be drawn in that form; WHILE variant is auto THE inline code SHALL be drawn in the form the nearest ancestor chooses for the inline code inside it (a table whose column is code, a callout, a list of names), and tonal where no ancestor chooses one; WHEN that choice changes while the inline code is shown THE inline code SHALL follow it at once. |
ICD-6 | THE inline code SHALL wrap with the line it sits in: it breaks first at the spaces inside it; a part with no space that is longer than the line SHALL break between any two characters rather than run past the edge of its container; and no hyphen or any other character SHALL be drawn at a break. Each piece of a run that breaks SHALL keep the fill, the corners and both paddings of ICD-3. THE inline code SHALL NOT cut its text and SHALL NOT scroll. |
ICD-7 | THE inline code SHALL draw the characters of text as given: every space is kept, a run of spaces is not collapsed, a line break in text is drawn as one space, and the text is not hyphenated, not capitalised or otherwise transformed, not translated by the platform's translation, not spell-checked and not turned into a link by itself. |
ICD-8 | THE inline code SHALL lay out its text as a left-to-right run of its own, isolated from the text around it, in every layout direction (PRS-26): a path, a call and an operator keep their order inside a right-to-left sentence and reorder nothing beside them; the run takes its place in the sentence by the sentence's own direction. |
ICD-9 | THE inline code SHALL take its layout direction from where it is used — the direction of the nearest ancestor that sets one, and the platform's own where none does — and SHALL have no direction setting of its own; WHEN that direction changes while the inline code is shown THE inline code SHALL draw itself for the new direction at once, without a motion of its own, keeping what it shows. |
ICD-10 | WHERE the inline code sits inside a link THE inline code SHALL draw its text in the link's color in place of comp.inline-code.label.color and the link's underline SHALL run under it; WHERE it sits inside strong text it SHALL gain sys.typescale.emphasis.body of weight over the weight of comp.inline-code.label.typescale, as strong text does (PRS-2); WHERE it sits inside emphasised text it SHALL NOT be slanted. |
ICD-11 | THE inline code SHALL NOT take pointer, touch or keyboard input of its own, SHALL NOT take focus or be a stop in the focus order, and SHALL NOT change anything it draws under a pointer, a press or focus: it has no hovered, focused, pressed, selected or disabled state, draws no state layer and no focus indicator, and emits no event. WHERE it is placed inside an element that takes input (a link, a button, a list item) input over it SHALL reach that element, which draws its own states. |
ICD-12 | THE inline code SHALL expose its text as text, read where it sits in the sentence, with the role of code where the platform has one and no name of its own; it SHALL NOT be announced as anything else and SHALL NOT expose its form. Selecting it SHALL select its characters with the text around it, and copying that selection SHALL yield exactly text: no character stands for the padding of ICD-3. |
ICD-13 | THE inline code SHALL draw all of its text in one color: it takes no syntax roles and SHALL NOT highlight, parse or otherwise interpret what it holds. |
ICD-14 | WHERE the platform draws with a person's own forced colors THE inline code SHALL draw its text in the platform's text color (the link color inside a link) and no fill, and an edge only where comp.inline-code.outline.width is above 0, in that text color: the face tells code from words, so nothing rests on the fill. |
ICD-15 | WHILE the text size is enlarged THE inline code SHALL grow with the text it sits in, keeping the proportion of ICD-1, its padding and its corners; at twice the text size in a container 320 wide it SHALL wrap as ICD-6 says and SHALL NOT cause horizontal scrolling. |
ICD-16 | IF text is empty THE inline code SHALL draw nothing, take no space and expose nothing. WHEN variant names a value this spec does not have THE inline code SHALL be drawn as variant auto, and in debug builds report the unknown value. |
プラットフォーム別の名前対応
パリティは API が同一であることを意味しません。同じ契約を、各プラットフォームの流儀で表現します。
| 仕様 | Web | SwiftUI | Jetpack Compose | Flutter | React Native |
|---|---|---|---|---|---|
| コンポーネント | tanrei-code | TanreiInlineCode | TanreiInlineCode | TanreiInlineCode | InlineCode |
text · プロパティ | textContent | text | text | text | children |
variant · プロパティ | data-variant | variant | variant | variant | variant |
| 備考 | A class, not an element, as prose is: <code class="tanrei-code">npm install</code> from the optional stylesheet @tanrei/web/code.css, and every code that is prose's own and not inside a pre when prose.css is loaded (the code rules of prose.css move here; PRS-16's islands apply). The text is the element's own content, so it is in the document for search engines, find-in-page and copy without script. variant is data-variant="tonal | plain" on the code; an ancestor chooses with data-tanrei-code="plain" (ICD-5), which rendered Markdown cannot set per run and a table or a callout can set once. ICD-1: font-family, font-weight and letter-spacing from the code role and font-size: calc(1em * var(--tanrei-comp-inline-code-label-scale)), so a heading's size is followed without a rule per level. ICD-2: line-height: 0 on the run, as today, and no block padding. ICD-6: overflow-wrap: anywhere, white-space: pre-wrap, hyphens: none, box-decoration-break: clone. ICD-7: translate="no" and spellcheck="false" are the author's or the renderer's attributes; the README says so. ICD-8: direction: ltr; unicode-bidi: isolate. ICD-14: forced-color-adjust is left alone; the fill is a background, which the mode removes. | TanreiInlineCode(_ text: String, variant:) is a Text that concatenates with the Text around it (Text("Run ") + TanreiInlineCode("npm install")), and AttributedString.tanreiInlineCode(variant:) styles a run of a renderer's attributed string. The ancestor's choice is an environment value. A Text run can carry a background color but neither corners nor padding: inside a sentence the tonal form is a square fill without ICD-3's padding, and the README says so; a run that stands alone is drawn whole. | AnnotatedString.Builder.tanreiInlineCode(text, variant) adds the run with its span style and an annotation, and Modifier.tanreiInlineCode() on the Text that holds it draws the fills behind the annotated ranges from the text layout (one rounded rectangle per line piece). TanreiInlineCode(text, variant) is a composable for a run that stands alone. The ancestor's choice is a composition local. | TanreiInlineCode.span(text, variant:) returns an InlineSpan for Text.rich; the fill is painted behind the run's boxes by TanreiInlineCodeText, which wraps the rich text. TanreiInlineCode(text) is a widget for a run that stands alone. The ancestor's choice is an inherited widget. | <InlineCode>npm install</InlineCode> nested in a <Text>. A nested Text takes a background color but, on iOS, neither corners nor padding: the tonal form inside a sentence is a square fill there, stated in the README. The ancestor's choice is a context. Follows the app's direction where an ancestor's is not known. |
トークン
| トークン | 参照先 | 解決値（ライト） |
|---|---|---|
--tanrei-comp-inline-code-container-color | sys.color.surface-container-highest | |
--tanrei-comp-inline-code-container-padding-inline | sys.space.space50 | 4px |
--tanrei-comp-inline-code-container-shape | sys.shape.corner.extra-small | 3px |
--tanrei-comp-inline-code-label-color | sys.color.on-surface | |
--tanrei-comp-inline-code-label-scale | — | 0.9286 |
--tanrei-comp-inline-code-outline-color | sys.color.outline-variant | |
--tanrei-comp-inline-code-outline-width | sys.space.space0 | 0px |
--tanrei-comp-inline-code-label-typescale | sys.typescale.code | 400 13px/1.5385 |
フィクスチャ
基準となる描画パターンです。全プラットフォームが同じ ID でスナップショットを撮り、結果を比較できるようにしています。
tonal
text: npm install plain
text: npm install variant: plain spaces
text: git commit -m "fix: a typo" long
text: tanrei.comp.navigation-drawer.item.selec… rtl
text: src/app/main.ts direction: rtl in-paragraph
{} in-heading
{} in-large-text
{} in-link-and-strong
{} wrapping
{} plain-in-table
variant: plain japanese
{} in-rtl-paragraph
direction: rtl 生成元 specs/inline-code.spec.json, tokens/comp/inline-code.tokens.json, design/tokens/
translate="no"とspellcheck="false"は、プロダクト側または Markdown レンダラーが付ける属性です。スタイルシートからは設定できません。- コードの中のハイフンは、文字の間で折り返す前に、行が終わってもよい位置として扱われます。
- WebKit では、折り返した断片のそれぞれに塗りと角丸を描きますが、両端の余白は描きません。2 つ目以降の断片は塗りの端から始まります。
- コードの中の改行が 1 つの空白として描かれるのは、
white-space-collapse: preserve-spacesに対応したブラウザーだけです。コードは 1 行で書いてください。 - 未知の
data-variantはautoとして描かれます。デバッグビルドでも報告はありません。
| 種類 | 描き方 | 使う場面 |
|---|---|---|
| Tonal | 薄い塗りの上にコード用の書体 | 文章の中の名前 |
| Plain | コード用の書体だけ。色はまわりのテキストと同じ | すべての項目がコードである列やリスト、色の付いたコンテナの上のテキスト |
- コードを言葉として読み上げても意味が通るように文を書きます。スクリーンリーダーは、既定ではコードのロールを読み上げません。
- ステータスのコンテナや反転したサーフェスなど、色の付いたコンテナの上では Plain を使います。Tonal の塗りはサーフェスのロールで、サーフェスとの組み合わせだけを保証しています。
- 表や名前のリストでは、祖先に 1 度だけバリアントを指定します（
data-tanrei-code="plain"）。
- 強調のためにインラインコードを使わない。インラインコードは「これはコードです」という意味を持ちます。
- 押すキーをインラインコードで書かない。キーボードショートカットを使います。
- 1 行を超えるコードを入れない。コードブロックを使います。
- ロール
code- ラベル付け
- Inline code has no name of its own: it is text, read in its sentence. Its role is code where the platform has one (the web's code element); elsewhere it is plain text. Nothing announces its form.
- 最小ターゲット
- 見た目のサイズが小さくても、ヒット領域は最小ターゲットサイズを満たします。 minimum 32px · pointer 44px · spacing 8px · touch 48px
キーボード操作
| キー | 動作 |
|---|
備考
- Not interactive: inline code takes no input and no focus (ICD-11), so there is no target to size; minimumTarget holds trivially. Inside a link it is part of that link's text and target.
- Told from the words around it by its face, not by color (WCAG 1.4.1): the fill is decorative, and the plain form and forced colors (ICD-14) draw none.
- Contrast in the default system: the tonal form's text is on-surface on surface-container-highest, and a link's color on that fill is held at the same ratio — both by the token invariants that hold text roles at 4.5:1 on every surface (7:1 in the high-contrast schemes). The plain form has the contrast of the text it sits in.
- The tonal form's fill is a surface role, so it is correct on a surface. On a colored container (a callout, an inverse tooltip, a filled button) the text color of ICD-3 is not paired with that container's content color: use plain there. A component that hosts text on such a container chooses plain for the inline code inside it (ICD-5).
- Screen readers do not announce the code role by default, so a sentence must make sense when the code is read as words. Symbols are read as the person's settings say; write a name out in the sentence where its spelling matters.
- It reflows (WCAG 1.4.10): a long name breaks rather than scroll the page (ICD-6, ICD-15). No hyphen is added, because a hyphen would change the code.
- Keys to press are a keyboard shortcut, which reads modifier names aloud; inline code would read the characters.
生成元 specs/inline-code.spec.json, tokens/sys/measure.tokens.json
code要素なので、コードのロールを持ち、テキストは文の中の位置で読み上げられます。- まわりの言葉とは、色ではなく書体で区別できます。強制カラーモードでは塗りが消えますが、失われる情報はありません。
- フォーカスも入力も受け取りません。リンクやボタンの中では、コードの上を押すとその要素に届きます。
- 長い名前は、どのテキストサイズでも、ページを横にスクロールさせずに折り返します。
- 文を選択してコピーすると、コードの文字がそのままコピーされます。
- つづりが重要な名前は、文の中でも言葉で書きます。記号の読み方はユーザーの設定によって変わるためです。
- ブラウザーの翻訳がコードを書き換えないよう、
translate="no"を付けます。