Código en línea
Un tramo de código dentro de una frase, en el tipo de letra de código y al tamaño del texto que lo rodea, sobre un relleno tenue o sin él. Es texto, nunca un control.
- Categoría
- Comunicación
- Tokens
comp.inline-code- Nivel
- Base
- Web
tanrei-codeschedule - SwiftUI
TanreiInlineCoderadio_button_unchecked - Jetpack Compose
TanreiInlineCoderadio_button_unchecked - Flutter
TanreiInlineCoderadio_button_unchecked - React Native
InlineCoderadio_button_unchecked
Generado a partir de docs/status/status.json, specs/inline-code.spec.json
En una frase, en un encabezado y plain
Ejecuta npm install en la carpeta que contiene
package.json y después inicia el servidor con
npm run dev -- --port 4000.
Definir size en un grupo
Plain: comp.button.container.shape
El código en línea nombra dentro de una frase algo que viene del código: un comando, una propiedad, un archivo, un valor. Las líneas de código que se leen y se copian son un bloque de código. Las teclas que hay que pulsar son un atajo de teclado, que lee en voz alta los nombres de los modificadores.
En la web, el código en línea es una clase que pones en tu propio elemento code, no un elemento. El texto está en el documento, así que los buscadores, la búsqueda en la página y la copia funcionan antes de que se ejecute ningún script. Todos los code dentro de .tanrei-prose que no están en un pre se dibujan igual sin necesidad de la clase, así que el Markdown renderizado no necesita nada.
SwiftUI, Compose, Flutter y React Native están planificados: los nombres que figuran junto a cada plataforma al principio de esta página son los que les da la especificación, y todavía no se distribuye nada para ellos.
<link rel="stylesheet" href="@tanrei/web/tokens.css" />
<link rel="stylesheet" href="@tanrei/web/code.css" />
<!-- Tonal: el valor predeterminado. -->
<p>Ejecuta primero <code class="tanrei-code" translate="no" spellcheck="false">npm install</code>.</p>
<!-- Plain: solo el tipo de letra, en el color del texto que lo rodea. -->
<code class="tanrei-code" data-variant="plain">comp.button.container.shape</code>
<!-- Un ancestro elige por todos los tramos que contiene. -->
<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>Ejecuta primero <code className="tanrei-code" translate="no" spellCheck={false}>npm install</code>.</p>| Propiedad | En la web |
|---|---|
text |
El propio contenido del elemento |
variant: tonal |
data-variant="tonal" |
variant: plain |
data-variant="plain" |
variant: auto (el valor predeterminado) |
Sin atributo. Elige el ancestro más cercano con data-tanrei-code="plain" o "tonal", y es tonal donde ninguno lo hace |
Salta de línea, y cada trozo conserva su relleno
El token tanrei.comp.navigation-drawer.item.selected.hovered.state-layer.color es más largo que esta línea. Se parte donde termina la línea y nunca se corta.
En un enlace, en texto fuerte y una columna de código
Consulta la referencia de Button. Nunca definas disabled en la única salida.
PropiedadPredeterminado
variantfilledsizemediumEl código en línea no tiene tamaño propio. Su tamaño de fuente es el del texto en el que está, multiplicado por una proporción (comp.inline-code.label.scale) que iguala el tipo de letra de código y el del texto. En el texto de cuerpo es 13 junto a 14. En un encabezado es el tamaño del propio encabezado.
Nunca hace más alta su línea. El relleno es tan alto como la caja de texto del propio tipo de letra de código y no tiene margen interior ni arriba ni abajo.
Un tramo salta de línea con su línea. Se parte primero por sus espacios. Una parte sin espacios que es más larga que la línea se parte entre caracteres, y no se añade ningún guion, porque un guion cambiaría el código. Nunca se corta y nunca se desplaza.
Dentro de un enlace toma el color del enlace, y el subrayado del enlace pasa por debajo de él. Dentro de texto fuerte es un paso de peso más grueso. Nunca se inclina.
Siempre se dispone de izquierda a derecha, como un tramo aparte, también en una frase de derecha a izquierda.
Anatomía
| Parte | Descripción |
|---|---|
1 container · opcional | 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 · opcional | An edge around the fill, where a design system gives it a width. The default system draws none. |
Propiedades
| Propiedad | Tipo | Valor predeterminado | Descripción |
|---|---|---|---|
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. |
Estados
Comportamiento
Requisitos en formato EARS. Cada implementación de plataforma se prueba contra estos identificadores. El texto de los requisitos se muestra tal como está en la especificación, en inglés.
| ID | Requisito |
|---|---|
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. |
Correspondencia de nombres por plataforma
Paridad no significa API idénticas. Cada plataforma expresa el mismo contrato con su propio estilo.
| Especificación | Web | SwiftUI | Jetpack Compose | Flutter | React Native |
|---|---|---|---|---|---|
| Componente | tanrei-code | TanreiInlineCode | TanreiInlineCode | TanreiInlineCode | InlineCode |
text · Propiedad | textContent | text | text | text | children |
variant · Propiedad | data-variant | variant | variant | variant | variant |
| Notas | 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. |
Tokens
| Token | Alias de | Valor resuelto (claro) |
|---|---|---|
--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 |
Fixtures
Representaciones canónicas. Todas las plataformas capturan cada fixture con el mismo identificador para poder comparar los resultados.
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 Generado a partir de specs/inline-code.spec.json, tokens/comp/inline-code.tokens.json, design/tokens/
translate="no"yspellcheck="false"son atributos tuyos, o de tu renderizador de Markdown. Una hoja de estilos no puede definirlos.- Un guion en el código es un lugar donde puede terminar una línea, antes de que el tramo se parta entre caracteres.
- WebKit dibuja el relleno y las esquinas de cada trozo de un tramo que salta de línea, pero no el espacio de cada extremo: los trozos posteriores al primero empiezan en el borde del relleno.
- Un salto de línea dentro del tramo se dibuja como un solo espacio únicamente en los navegadores que admiten
white-space-collapse: preserve-spaces. Escribe cada tramo en una sola línea. - Un
data-variantdesconocido se dibuja comoauto, y las compilaciones de depuración no notifican nada.
| Variante | Qué dibuja | Úsalo cuando |
|---|---|---|
| Tonal | El tipo de letra de código sobre un relleno tenue | Un nombre en el texto corrido |
| Plain | Solo el tipo de letra de código, en el color del texto que lo rodea | Una columna o una lista en la que todas las entradas son código, y un texto sobre un contenedor de color |
- Escribe la frase de modo que se entienda cuando el código se dice como palabras. Los lectores de pantalla no anuncian el rol de código de forma predeterminada.
- Usa plain sobre un contenedor de color, como un contenedor de estado o una superficie inversa. El relleno tonal es un rol de superficie y solo se empareja con superficies.
- Elige la variante una sola vez en el ancestro (
data-tanrei-code="plain") para una tabla o una lista de nombres.
- No uses el código en línea para dar énfasis. Dice «esto es código».
- No pongas en código en línea las teclas que hay que pulsar. Usa un atajo de teclado.
- No pongas en él más de una línea. Usa un bloque de código.
- Rol
code- Etiquetado
- 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.
- Objetivo mínimo
- El área de pulsación cumple el tamaño mínimo de objetivo aunque el tamaño visual sea menor. minimum 32px · pointer 44px · spacing 8px · touch 48px
Teclado
| Teclas | Acción |
|---|
Notas
- 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.
Generado a partir de specs/inline-code.spec.json, tokens/sys/measure.tokens.json
- Es el elemento
code, así que tiene el rol de código, y su texto se lee donde está dentro de la frase. - Se distingue de las palabras que lo rodean por su tipo de letra, no por el color. Con colores forzados el relleno desaparece y no se pierde nada.
- No recibe foco ni entrada. Dentro de un enlace o de un botón, una pulsación sobre él llega a ese elemento.
- Un nombre largo se parte en lugar de hacer que la página se desplace, con cualquier tamaño de texto.
- Al seleccionar y copiar una frase, los caracteres del código se copian exactamente.
- Escribe un nombre con todas sus letras en la frase cuando su grafía importe, porque los símbolos se leen según los ajustes de cada persona.
- Marca el tramo con
translate="no"para que la traducción del navegador no lo toque.