code-view/src/__tests__/__snapshots__/documenter.test.ts.snap at df9f1b73d942b37907ac8c692a1e11ce26575f35 · akoreman/code-view · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`definition for code-view matches the snapshot 1`] = `
{
  "events": [],
  "functions": [],
  "name": "CodeView",
  "properties": [
    {
      "description": "Adds an \`aria-label\` to the component. Use this label when there is not enough context around the code snippet to describe its purpose or content.",
      "name": "ariaLabel",
      "optional": true,
      "type": "string",
    },
    {
      "description": "Adds \`aria-labelledby\` to the component. Use this property to reference the ID of an existing element that provides a descriptive label for the code snippet.",
      "name": "ariaLabelledby",
      "optional": true,
      "type": "string",
    },
    {
      "description": "The code content to be displayed.",
      "name": "content",
      "optional": false,
      "type": "string",
    },
    {
      "description": "A function to perform custom syntax highlighting.",
      "name": "highlight",
      "optional": true,
      "type": "(code: string) => React.ReactNode",
    },
    {
      "description": "Controls the display of line numbers.
Defaults to \`false\`.
",
      "name": "lineNumbers",
      "optional": true,
      "type": "boolean",
    },
    {
      "description": "Controls whether line-wrapping is enabled when content would overflow the component.
Defaults to \`false\`.
",
      "name": "wrapLines",
      "optional": true,
      "type": "boolean",
    },
  ],
  "regions": [
    {
      "description": "An optional slot to display a button to enable users to perform actions, such as copy or download the code snippet.",
      "isDefault": false,
      "name": "actions",
    },
  ],
  "releaseStatus": "stable",
}
`;