@slotted/react 0.1.0-beta.1 → 0.1.0-beta.11

package/dist/docs/markdown.json

@@ -59,55 +59,55 @@
           "part": "root",
           "element": "div",
           "required": true,
-          "purpose": "A família: data-ui=\"markdown\", data-status, data-flow, data-loading, data-empty, data-streaming e aria-busy. Os estados vazio, erro e carregamento desenham-se aqui, fora da tipografia da região."
+          "purpose": "The family: data-ui=\"markdown\", data-status, data-flow, data-loading, data-empty, data-streaming and aria-busy. The empty, error and loading states are drawn here, outside the region’s typography."
         },
         {
           "part": "embed",
           "element": "div",
           "required": false,
-          "purpose": "Segura um code-block ou um alert e dá-lhe o fluxo da região, lido dos tokens públicos de prose; prose só espaça os elementos que conhece."
+          "purpose": "Holds a code-block or an alert and gives it the region’s flow, read from the public prose tokens; prose only spaces the elements it knows."
         },
         {
           "part": "alert-body",
           "element": "div",
           "required": false,
-          "purpose": "Os blocos de um alerta do GitHub dentro da descrição do alert; o primeiro começa rente ao título."
+          "purpose": "The blocks of a GitHub alert inside the alert’s description; the first starts flush with the title."
         },
         {
           "part": "task-list",
           "element": "ul | ol",
           "required": false,
-          "purpose": "Uma lista em que pelo menos um item é tarefa. Os itens comuns mantêm o marcador."
+          "purpose": "A list in which at least one item is a task. The ordinary items keep the marker."
         },
         {
           "part": "task",
           "element": "li",
           "required": false,
-          "purpose": "Uma grelha de duas colunas: o checkbox onde estava o marcador, depois o corpo. O texto começa na mesma aresta que o de um item comum."
+          "purpose": "A two-column grid: the checkbox where the marker was, then the body. The text starts on the same edge as that of an ordinary item."
         },
         {
           "part": "task-body",
           "element": "div",
           "required": false,
-          "purpose": "O conteúdo da tarefa, incluindo uma lista aninhada."
+          "purpose": "The task content, including a nested list."
         },
         {
           "part": "backref",
           "element": "a",
           "required": false,
-          "purpose": "O retorno de uma nota de rodapé à sua referência: uma seta para cima num alvo de 24 px, uma por referência."
+          "purpose": "The return from a footnote to its reference: an up arrow on a 24 px target, one per reference."
         },
         {
           "part": "empty",
           "element": "p",
           "required": false,
-          "purpose": "O documento não tem conteúdo: messages.empty, ou o nó do consumidor em empty."
+          "purpose": "The document has no content: messages.empty, or the consumer’s node in empty."
         },
         {
           "part": "error",
           "element": "div",
           "required": false,
-          "purpose": "A fonte não chegou: inline-message em danger com messages.error e, com onRetry, um botão de repetir."
+          "purpose": "The source did not arrive: inline-message in danger with messages.error and, with onRetry, a retry button."
         }
       ],
       "api": [
@@ -116,133 +116,133 @@
           "type": "MarkdownNode | null",
           "defaultValue": "—",
           "appliesTo": "Markdown",
-          "description": "O documento em mdast; nunca HTML"
+          "description": "The document in mdast; never HTML"
         },
         {
           "name": "size",
           "type": "'md' | 'lg' | 'xl'",
           "defaultValue": "lg",
           "appliesTo": "Markdown",
-          "description": "O degrau de tipo da região, de prose"
+          "description": "The region’s type step, from prose"
         },
         {
           "name": "flow",
           "type": "'tight' | 'normal' | 'loose'",
           "defaultValue": "normal",
           "appliesTo": "Markdown",
-          "description": "O espaço entre blocos, de prose"
+          "description": "The space between blocks, from prose"
         },
         {
           "name": "status",
           "type": "'ready' | 'error'",
           "defaultValue": "ready",
           "appliesTo": "Markdown",
-          "description": "error troca o documento pela parte error"
+          "description": "error replaces the document with the error part"
         },
         {
           "name": "loading",
           "type": "boolean",
           "defaultValue": "false",
           "appliesTo": "Markdown",
-          "description": "Um parágrafo de espera, depois do delay do skeleton"
+          "description": "A waiting paragraph, after the skeleton delay"
         },
         {
           "name": "streaming",
           "type": "boolean",
           "defaultValue": "false",
           "appliesTo": "Markdown",
-          "description": "aria-busy enquanto a fonte chega"
+          "description": "aria-busy while the source arrives"
         },
         {
           "name": "external",
           "type": "'new-tab' | 'same-tab'",
           "defaultValue": "new-tab",
           "appliesTo": "Markdown",
-          "description": "Onde abre um link que sai da aplicação"
+          "description": "Where a link that leaves the application opens"
         },
         {
           "name": "headingAnchors",
           "type": "boolean",
           "defaultValue": "false",
           "appliesTo": "Markdown",
-          "description": "Um permalink em cada título"
+          "description": "A permalink on every heading"
         },
         {
           "name": "headingOffset",
           "type": "number",
           "defaultValue": "0",
           "appliesTo": "Markdown",
-          "description": "Somado ao nível de cada título, até seis"
+          "description": "Added to the level of each heading, up to six"
         },
         {
           "name": "idPrefix",
           "type": "string",
           "defaultValue": "",
           "appliesTo": "Markdown",
-          "description": "Antes de cada id gerado; obrigatório com duas regiões na página"
+          "description": "Before each generated id; required with two regions on the page"
         },
         {
           "name": "alerts",
           "type": "boolean",
           "defaultValue": "true",
           "appliesTo": "Markdown",
-          "description": "Lê > [!NOTE] e os irmãos como alert"
+          "description": "Reads > [!NOTE] and its siblings as alert"
         },
         {
           "name": "allow",
           "type": "string[]",
-          "defaultValue": "CommonMark + GFM sem html",
+          "defaultValue": "CommonMark + GFM without html",
           "appliesTo": "Markdown",
-          "description": "Os tipos mdast desenhados"
+          "description": "The mdast types drawn"
         },
         {
           "name": "unwrapDisallowed",
           "type": "boolean",
           "defaultValue": "false",
           "appliesTo": "Markdown",
-          "description": "Um tipo recusado entrega os filhos ao pai"
+          "description": "A refused type hands its children to the parent"
         },
         {
           "name": "transformUrl",
           "type": "(url, kind, node) => string | null",
           "defaultValue": "safeUrl",
           "appliesTo": "Markdown",
-          "description": "A política de URL; null recusa"
+          "description": "The URL policy; null refuses"
         },
         {
           "name": "isExternal",
           "type": "(href) => boolean",
           "defaultValue": "isExternalUrl",
           "appliesTo": "Markdown",
-          "description": "Se um link sai da aplicação"
+          "description": "Whether a link leaves the application"
         },
         {
           "name": "renderers",
           "type": "MarkdownRenderers",
           "defaultValue": "—",
           "appliesTo": "Markdown",
-          "description": "Substitui o elemento de um tipo conhecido"
+          "description": "Replaces the element of a known type"
         },
         {
           "name": "extensions",
           "type": "MarkdownExtensions",
           "defaultValue": "—",
           "appliesTo": "Markdown",
-          "description": "Desenha um tipo que a família não conhece"
+          "description": "Draws a type the family does not know"
         },
         {
           "name": "messages",
           "type": "PartialMessages<MarkdownMessages>",
           "defaultValue": "—",
           "appliesTo": "Markdown",
-          "description": "As palavras da família sobre o idioma em vigor, chave a chave"
+          "description": "The family’s words over the current locale, key by key"
         },
         {
           "name": "empty",
           "type": "ReactNode",
           "defaultValue": "—",
           "appliesTo": "Markdown",
-          "description": "O conteúdo da parte empty"
+          "description": "The content of the empty part"
         }
       ],
       "composition": [
@@ -251,76 +251,76 @@
           "type": "(props) => ReactNode",
           "defaultValue": "—",
           "appliesTo": "Markdown",
-          "description": "A raiz noutro elemento: article, section"
+          "description": "The root as another element: article, section"
         },
         {
           "name": "ref",
           "type": "Ref<HTMLDivElement>",
           "defaultValue": "—",
           "appliesTo": "Markdown",
-          "description": "O elemento da raiz"
+          "description": "The root element"
         },
         {
           "name": "MarkdownDefaultsProvider",
           "type": "external | headingAnchors | alerts | allow | transformUrl | isExternal",
           "defaultValue": "—",
-          "appliesTo": "Aplicação",
-          "description": "Decidido uma vez para todos os documentos por baixo; uma prop ganha"
+          "appliesTo": "Application",
+          "description": "Decided once for every document below; a prop wins"
         },
         {
           "name": "prepareMarkdown",
           "type": "(tree, options) => MarkdownDocument",
           "defaultValue": "—",
           "appliesTo": "@slotted/core/markdown",
-          "description": "headings para um índice, com os ids da página"
+          "description": "headings for a table of contents, with the page’s ids"
         },
         {
           "name": "completeMarkdown",
           "type": "(source) => string",
           "defaultValue": "—",
           "appliesTo": "@slotted/core/markdown",
-          "description": "Fecha uma fonte cortada antes do parser"
+          "description": "Closes a cut source before the parser"
         },
         {
           "name": "fromMarkedTokens",
           "type": "(tokens) => MarkdownNode",
           "defaultValue": "—",
           "appliesTo": "@slotted/core/markdown",
-          "description": "O lexer do marked como mdast"
+          "description": "The marked lexer as mdast"
         },
         {
           "name": "CodeBlockDefaultsProvider",
           "type": "highlight",
           "defaultValue": "—",
-          "appliesTo": "Aplicação",
-          "description": "O motor de realce de cada cerca"
+          "appliesTo": "Application",
+          "description": "The highlighting engine of each fence"
         },
         {
           "name": "id, aria-*, data-*, on*",
-          "type": "props nativas",
+          "type": "native props",
           "defaultValue": "—",
           "appliesTo": "Markdown",
-          "description": "Chegam à raiz"
+          "description": "Reach the root"
         }
       ],
       "events": [
         {
           "name": "onTaskChange",
           "payload": "({ index, checked, offset }, request)",
-          "when": "Quando o leitor marca ou desmarca uma tarefa, com a razão pointer ou keyboard. A caixa não se move: a árvore nova do consumidor é que a move."
+          "when": "When the reader checks or unchecks a task, with the reason pointer or keyboard. The box does not move: the consumer’s new tree moves it."
         },
         {
           "name": "onRetry",
           "payload": "(reason: 'pointer' | 'keyboard')",
-          "when": "Quando o leitor pressiona o botão de repetir da parte error."
+          "when": "When the reader presses the retry button of the error part."
         }
       ],
       "accessibility": [
-        "Nenhuma string da fonte chega a innerHTML: a família recebe uma árvore, recusa HTML cru e esquemas executáveis por omissão, e cada elemento é criado pelo framework.",
-        "Os títulos são títulos de verdade, deslocáveis com headingOffset para caberem no esboço da página; a âncora fica na ordem de tabulação e na árvore de acessibilidade, com o nome \"Link to section: <título>\".",
-        "Uma tarefa é um checkbox nomeado pelo texto do item; sem onTaskChange é aria-readonly, não disabled, por isso continua focável e legível.",
-        "Cada referência de nota tem aria-describedby para o título escondido da secção, e cada retorno diz para qual referência volta; um alerta do GitHub é live=\"off\", porque é conteúdo e não um evento.",
-        "streaming e loading põem aria-busy na raiz, e o skeleton faz um único anúncio educado; nada move o foco quando o conteúdo chega."
+        "No source string reaches innerHTML: the family receives a tree, refuses raw HTML and executable schemes by default, and each element is created by the framework.",
+        "The headings are real headings, shiftable with headingOffset to fit the page outline; the anchor stays in the tab order and in the accessibility tree, with the name \"Link to section: <heading>\".",
+        "A task is a checkbox named by the item’s text; without onTaskChange it is aria-readonly, not disabled, so it stays focusable and readable.",
+        "Each note reference has aria-describedby pointing to the hidden heading of the section, and each return says which reference it goes back to; a GitHub alert is live=\"off\", because it is content and not an event.",
+        "streaming and loading put aria-busy on the root, and the skeleton makes a single polite announcement; nothing moves focus when the content arrives."
       ]
     }
   },
@@ -346,111 +346,111 @@
     {
       "id": "playground",
       "title": "Playground",
-      "note": "Um runbook escrito em Markdown, passado pelo lexer do marked e por fromMarkedTokens. Os controlos por baixo do palco movem o tamanho, o fluxo, as âncoras e o deslocamento dos títulos.",
+      "note": "A runbook written in Markdown, passed through the marked lexer and fromMarkedTokens. The controls below the stage move the size, the flow, the anchors and the heading offset.",
       "language": "tsx",
       "source": "import { marked } from 'marked';\n\nconst tree = fromMarkedTokens(marked.lexer(source));\n\n<Markdown headingAnchors tree={tree} />;\n",
       "verdict": "excerpt"
     },
     {
       "id": "document",
-      "title": "Um documento inteiro",
-      "note": "Títulos com id estável, ênfase, código em linha, listas aninhadas, uma citação e uma régua: tudo em prose, cuja tipografia é a da região. Passe o ponteiro por um título para ver a âncora; com Tab ela aparece também.",
+      "title": "A whole document",
+      "note": "Headings with a stable id, emphasis, inline code, nested lists, a quote and a rule: all in prose, whose typography is the region’s. Hover a heading to see the anchor; with Tab it appears too.",
       "language": "tsx",
       "source": "<Markdown headingAnchors tree={tree} />;\n",
       "verdict": "excerpt"
     },
     {
       "id": "tables",
-      "title": "Tabelas do GFM",
-      "note": "O alinhamento :-- e --: chega como start e end, por isso uma tabela vista em RTL mantém os preços contra a aresta onde a leitura termina. Uma tabela mais larga do que a coluna rola dentro da parte scroll de prose, que só ganha tabindex e nome enquanto transborda.",
+      "title": "GFM tables",
+      "note": "The :-- and --: alignment arrives as start and end, so a table seen in RTL keeps the prices against the edge where reading ends. A table wider than the column scrolls inside the prose scroll part, which only gains tabindex and a name while it overflows.",
       "language": "markdown",
-      "source": "| Plano | Lugares |   Preço |\n| :---- | :-----: | ------: |\n| Team  |   10    | $120.00 |\n",
+      "source": "| Plan | Seats |   Price |\n| :--- | :---: | ------: |\n| Team |  10   | $120.00 |\n",
       "verdict": "excerpt"
     },
     {
       "id": "code",
-      "title": "Cercas com code-block",
-      "note": "Cada cerca é um CodeBlock: a linguagem da info string, e o que vem depois dela — title=\"…\", {2} e showLineNumbers — chega como título, linha realçada e números. O realce de sintaxe é o do CodeBlockDefaultsProvider.",
+      "title": "Fences with code-block",
+      "note": "Each fence is a CodeBlock: the language from the info string, and what comes after it — title=\"…\", {2} and showLineNumbers — arrives as title, highlighted line and numbers. The syntax highlighting is that of the CodeBlockDefaultsProvider.",
       "language": "markdown",
       "source": "```ts title=\"deploy.ts\" {2} showLineNumbers\nimport { deploy } from '@acme/cli';\nawait deploy({ env: 'production' });\n```\n",
       "verdict": "excerpt"
     },
     {
       "id": "tasks",
-      "title": "Listas de tarefas",
-      "note": "Sem onTaskChange as caixas são checkbox em readOnly: focáveis, anunciadas como só de leitura. Com ele, marcar uma tarefa pede a mudança com o índice e o offset na fonte; a caixa só se move quando a árvore nova chega.",
+      "title": "Task lists",
+      "note": "Without onTaskChange the boxes are checkboxes in readOnly: focusable, announced as read only. With it, checking a task requests the change with the index and the offset in the source; the box only moves when the new tree arrives.",
       "language": "tsx",
       "source": "<Markdown\n  onTaskChange={({ index, checked }) => setSource(toggleTask(source, index, checked))}\n  tree={fromMarkedTokens(marked.lexer(source))}\n/>;\n",
       "verdict": "excerpt"
     },
     {
       "id": "alerts",
-      "title": "Alertas do GitHub",
-      "note": "> [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] e [!CAUTION] tornam-se alert em reach=\"section\" e live=\"off\" — conteúdo, não anúncio — nos tons accent, success, secondary, warning e danger. alerts={false} devolve a citação.",
+      "title": "GitHub alerts",
+      "note": "> [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] and [!CAUTION] become an alert with reach=\"section\" and live=\"off\" — content, not an announcement — in the tones accent, success, secondary, warning and danger. alerts={false} gives back the quote.",
       "language": "markdown",
       "source": "> [!WARNING]\n> A deployment during a migration waits for the migration to finish.\n",
       "verdict": "excerpt"
     },
     {
       "id": "footnotes",
-      "title": "Notas de rodapé",
-      "note": "Numeradas pela primeira referência, com uma seta de retorno por referência dentro do último parágrafo da nota. A secção tem um título escondido que dá nome ao conjunto; uma definição que ninguém referencia não é desenhada, como no GitHub.",
+      "title": "Footnotes",
+      "note": "Numbered by the first reference, with one return arrow per reference inside the last paragraph of the note. The section has a hidden heading that names the set; a definition nobody references is not drawn, as on GitHub.",
       "language": "tsx",
       "source": "<Markdown messages={{ footnotes: 'Notas' }} tree={tree} />;\n",
       "verdict": "excerpt"
     },
     {
       "id": "links",
-      "title": "Links internos e externos",
-      "note": "Um endereço absoluto http(s) sai da aplicação: é um Link com o glifo e a dica de nova aba. Um caminho relativo é um a simples. external=\"same-tab\" mantém a aba; isExternal decide quais hosts são da casa.",
+      "title": "Internal and external links",
+      "note": "An absolute http(s) address leaves the application: it is a Link with the glyph and the new-tab hint. A relative path is a plain a. external=\"same-tab\" keeps the tab; isExternal decides which hosts belong to the application.",
       "language": "tsx",
       "source": "<Markdown\n  isExternal={(href) => /^https?:\\/\\//.test(href) && !href.startsWith('https://acme.example')}\n  tree={tree}\n/>;\n",
       "verdict": "excerpt"
     },
     {
       "id": "sanitisation",
-      "title": "Sanitização por construção",
-      "note": "A família nunca escreve innerHTML. HTML cru não é desenhado; javascript:, data: e as grafias disfarçadas perdem o link e ficam como texto; uma imagem recusada fica como o seu texto alternativo. transformUrl troca a política; allow restringe os tipos.",
+      "title": "Sanitization by construction",
+      "note": "The family never writes innerHTML. Raw HTML is not drawn; javascript:, data: and the disguised spellings lose the link and stay as text; a refused image stays as its alternative text. transformUrl swaps the policy; allow restricts the types.",
       "language": "tsx",
       "source": "<Markdown\n  allow={['paragraph', 'text', 'emphasis', 'strong', 'link']}\n  tree={tree}\n  unwrapDisallowed\n/>;\n",
       "verdict": "excerpt"
     },
     {
       "id": "renderers",
-      "title": "Renderizadores e extensões",
-      "note": "renderers substitui o elemento de um tipo conhecido — aqui o link vira o link do router da aplicação. extensions desenha um tipo que a família não conhece: uma menção @nome que um passo sobre a árvore criou. Um tipo sem renderizador não aparece.",
+      "title": "Renderers and extensions",
+      "note": "renderers replaces the element of a known type — here the link becomes the application’s router link. extensions draws a type the family does not know: an @name mention that a pass over the tree created. A type without a renderer does not appear.",
       "language": "tsx",
       "source": "<Markdown\n  extensions={{ mention: ({ element }) => <Tag>@{String(element.node.value)}</Tag> }}\n  renderers={{\n    link: ({ element, children }) => <RouterLink to={element.href}>{children}</RouterLink>,\n  }}\n  tree={withMentions(tree)}\n/>;\n",
       "verdict": "excerpt"
     },
     {
       "id": "streaming",
-      "title": "Uma resposta que ainda está a chegar",
-      "note": "completeMarkdown fecha o que o fluxo deixou aberto — a cerca, o **, a crase, o link cortado — antes do parser. Os blocos já desenhados mantêm a chave e não voltam a montar; streaming põe aria-busy na região até ao fim.",
+      "title": "An answer that is still arriving",
+      "note": "completeMarkdown closes what the stream left open — the fence, the **, the backtick, the cut link — before the parser. The blocks already drawn keep their key and do not mount again; streaming puts aria-busy on the region until the end.",
       "language": "tsx",
       "source": "<Markdown\n  idPrefix={`msg-${message.id}-`}\n  streaming={status === 'streaming'}\n  tree={fromMarkedTokens(marked.lexer(completeMarkdown(message.text)))}\n/>;\n",
       "verdict": "excerpt"
     },
     {
       "id": "states",
-      "title": "Carregando, vazio e erro",
-      "note": "loading desenha um parágrafo de três linhas depois do delay do skeleton, na tipografia da região; vazio escreve messages.empty ou o nó do consumidor; status=\"error\" troca o documento por uma mensagem e, com onRetry, um botão.",
+      "title": "Loading, empty and error",
+      "note": "loading draws a three-line paragraph after the skeleton delay, in the region’s typography; empty writes messages.empty or the consumer’s node; status=\"error\" replaces the document with a message and, with onRetry, a button.",
       "language": "tsx",
       "source": "<Markdown\n  loading={query.isLoading}\n  onRetry={query.refetch}\n  status={query.isError ? 'error' : 'ready'}\n  tree={query.data}\n/>;\n",
       "verdict": "excerpt"
     },
     {
       "id": "composition",
-      "title": "Numa página de documentação",
-      "note": "Container dá a medida, prepareMarkdown dá o índice com os mesmos ids que a página desenha, e MarkdownDefaultsProvider diz uma vez, em português, o que a família escreve.",
+      "title": "On a documentation page",
+      "note": "Container gives the measure, prepareMarkdown gives the table of contents with the same ids the page draws, and MarkdownDefaultsProvider says once, in Portuguese, what the family writes.",
       "language": "tsx",
       "source": "const { headings } = prepareMarkdown(tree);\n\n<MarkdownDefaultsProvider headingAnchors>\n  <Container size=\"measure\">\n    <Markdown messages={{ footnotes: 'Notas' }} tree={tree} />\n  </Container>\n</MarkdownDefaultsProvider>;\n",
       "verdict": "excerpt"
     },
     {
       "id": "accessibility",
-      "title": "Teclado e leitor de ecrã",
-      "note": "Tab percorre as âncoras dos títulos, os links, uma tabela que rola, os controlos de um bloco de código, as tarefas editáveis e os retornos das notas. A família não acrescenta tecla nenhuma: cada parada é de uma família composta.",
+      "title": "Keyboard and screen reader",
+      "note": "Tab goes through the heading anchors, the links, a table that scrolls, the controls of a code block, the editable tasks and the footnote returns. The family adds no key: each stop belongs to a composed family.",
       "language": "tsx",
       "source": "<Markdown headingAnchors headingOffset={1} tree={tree} />;\n",
       "verdict": "excerpt"