{
"schemaVersion": "1.0.0",
"readme": "",
"modules": [
{
"kind": "javascript-module",
"path": "/src/bundle.js",
"declarations": [],
"exports": [
{
"kind": "js",
"name": "*",
"declaration": {
"name": "*",
"package": "@nvidia-elements/code/codeblock"
}
}
]
},
{
"kind": "javascript-module",
"path": "/src/codeblock/codeblock.js",
"declarations": [
{
"kind": "class",
"description": "A container for content representing programming languages.",
"name": "CodeBlock",
"cssProperties": [
{
"name": "--background",
"description": "[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/background)"
},
{
"name": "--padding",
"description": "[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/padding)"
},
{
"name": "--border-radius",
"description": "[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/border-radius)"
},
{
"name": "--border",
"description": "[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/border)"
},
{
"name": "--font-family",
"description": "[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family)"
},
{
"name": "--white-space",
"description": "[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/white-space)"
}
],
"slots": [
{
"description": "for declarative slotting of source code and not using the `code` property",
"name": ""
},
{
"description": "slot for action bar",
"name": "actions"
}
],
"members": [
{
"kind": "field",
"name": "container",
"type": {
"text": "'flat' | 'inline' | \"default\"",
"_sourceAliases": [],
"values": [
{
"value": "flat",
"description": ""
},
{
"value": "inline",
"description": ""
}
]
},
"description": "Determines the container styles of component. Flat enables nesting within other containers.",
"attribute": "container",
"reflects": true
},
{
"kind": "field",
"name": "language",
"type": {
"text": "| 'bash'\n | 'css'\n | 'go'\n | 'html'\n | 'javascript'\n | 'json'\n | 'markdown'\n | 'python'\n | 'shell'\n | 'toml'\n | 'typescript'\n | 'xml'\n | 'yaml'",
"_sourceAliases": [],
"values": [
{
"value": "bash",
"description": ""
},
{
"value": "css",
"description": ""
},
{
"value": "go",
"description": ""
},
{
"value": "html",
"description": ""
},
{
"value": "javascript",
"description": ""
},
{
"value": "json",
"description": ""
},
{
"value": "markdown",
"description": ""
},
{
"value": "python",
"description": ""
},
{
"value": "shell",
"description": ""
},
{
"value": "toml",
"description": ""
},
{
"value": "typescript",
"description": ""
},
{
"value": "xml",
"description": ""
},
{
"value": "yaml",
"description": ""
}
]
},
"default": "'shell'",
"description": "Programming language that processes the codeblock.",
"attribute": "language"
},
{
"kind": "field",
"name": "code",
"type": {
"text": "string | \"default\"",
"_sourceAliases": [],
"values": [
{
"value": "string",
"description": ""
},
{
"value": "default",
"description": ""
}
]
},
"description": "Text code to be process into a codeblock.",
"attribute": "code"
},
{
"kind": "field",
"name": "lineNumbers",
"type": {
"text": "boolean | \"default\"",
"_sourceAliases": [],
"values": [
{
"value": "boolean",
"description": ""
},
{
"value": "default",
"description": ""
}
]
},
"description": "Adds styling to show the line numbers of the codeblock.",
"attribute": "line-numbers"
},
{
"kind": "field",
"name": "highlight",
"type": {
"text": "string | \"default\"",
"_sourceAliases": [],
"values": [
{
"value": "string",
"description": ""
},
{
"value": "default",
"description": ""
}
]
},
"description": "Adds styling to highlight the provided code lines.\nFor many lines: use Comma seperated values, ex: (1,5,7).\nFor range of lines, use hyphen seperated values, ex: (1-5).\nYou can combine both such as: ex: (1,5,10-15,20).",
"attribute": "highlight"
}
],
"attributes": [
{
"name": "container",
"type": {
"text": "'flat' | 'inline' | \"default\"",
"_sourceAliases": [],
"values": [
{
"value": "flat",
"description": ""
},
{
"value": "inline",
"description": ""
}
]
},
"description": "Determines the container styles of component. Flat enables nesting within other containers.",
"fieldName": "container"
},
{
"name": "language",
"type": {
"text": "| 'bash'\n | 'css'\n | 'go'\n | 'html'\n | 'javascript'\n | 'json'\n | 'markdown'\n | 'python'\n | 'shell'\n | 'toml'\n | 'typescript'\n | 'xml'\n | 'yaml'",
"_sourceAliases": [],
"values": [
{
"value": "bash",
"description": ""
},
{
"value": "css",
"description": ""
},
{
"value": "go",
"description": ""
},
{
"value": "html",
"description": ""
},
{
"value": "javascript",
"description": ""
},
{
"value": "json",
"description": ""
},
{
"value": "markdown",
"description": ""
},
{
"value": "python",
"description": ""
},
{
"value": "shell",
"description": ""
},
{
"value": "toml",
"description": ""
},
{
"value": "typescript",
"description": ""
},
{
"value": "xml",
"description": ""
},
{
"value": "yaml",
"description": ""
}
]
},
"default": "'shell'",
"description": "Programming language that processes the codeblock.",
"fieldName": "language"
},
{
"name": "code",
"type": {
"text": "string | \"default\"",
"_sourceAliases": [],
"values": [
{
"value": "string",
"description": ""
},
{
"value": "default",
"description": ""
}
]
},
"description": "Text code to be process into a codeblock.",
"fieldName": "code"
},
{
"name": "line-numbers",
"type": {
"text": "boolean | \"default\"",
"_sourceAliases": [],
"values": [
{
"value": "boolean",
"description": ""
},
{
"value": "default",
"description": ""
}
]
},
"description": "Adds styling to show the line numbers of the codeblock.",
"fieldName": "lineNumbers"
},
{
"name": "highlight",
"type": {
"text": "string | \"default\"",
"_sourceAliases": [],
"values": [
{
"value": "string",
"description": ""
},
{
"value": "default",
"description": ""
}
]
},
"description": "Adds styling to highlight the provided code lines.\nFor many lines: use Comma seperated values, ex: (1,5,7).\nFor range of lines, use hyphen seperated values, ex: (1-5).\nYou can combine both such as: ex: (1,5,10-15,20).",
"fieldName": "highlight"
}
],
"superclass": {
"name": "LitElement",
"package": "lit"
},
"tagName": "nve-codeblock",
"customElement": true,
"metadata": {
"unitTests": true,
"apiReview": true,
"performance": true,
"stable": true,
"vqa": true,
"responsive": true,
"themes": true,
"aria": "https://www.w3.org/WAI/ARIA/apg/practices/structural-roles/",
"entrypoint": "@nvidia-elements/code/codeblock",
"example": " function getTime(): number { return new Date().getTime(); } ",
"package": true,
"since": "0.1.0",
"status": "stable",
"behavior": "content",
"markdown": "## nve-codeblock\n\nA container for content representing programming languages.\n\n### Example\n\n```html\n function getTime(): number { return new Date().getTime(); } \n```\n\n### Import\n\n```javascript\nimport '@nvidia-elements/code/codeblock/define.js';\n```\n\n### Slots\n\n| name | value | description |\n| ---- | ----- | ----------- |\n| (default) | `string` | for declarative slotting of source code and not using the `code` property |\n| actions | `string` | slot for action bar |\n\n### Properties / Attributes\n\n| property (attribute) | value | description |\n| -------------------- | ----- | ----------- |\n| container | `'flat' \\| 'inline' \\| \"default\"` | Determines the container styles of component. Flat enables nesting within other containers. |\n| language | `\\| 'bash'\n \\| 'css'\n \\| 'go'\n \\| 'html'\n \\| 'javascript'\n \\| 'json'\n \\| 'markdown'\n \\| 'python'\n \\| 'shell'\n \\| 'toml'\n \\| 'typescript'\n \\| 'xml'\n \\| 'yaml'` | Programming language that processes the codeblock. |\n| code | `string \\| \"default\"` | Text code to be process into a codeblock. |\n| lineNumbers (line-numbers) | `boolean \\| \"default\"` | Adds styling to show the line numbers of the codeblock. |\n| highlight | `string \\| \"default\"` | Adds styling to highlight the provided code lines. For many lines: use Comma seperated values, ex: (1,5,7). For range of lines, use hyphen seperated values, ex: (1-5). You can combine both such as: ex: (1,5,10-15,20). |\n\n### CSS Properties\n\n| name | value | description |\n| ---- | ----- | ----------- |\n| --background | `string` | [MDN](https://mdn.dev/CSS/background) |\n| --padding | `string` | [MDN](https://mdn.dev/CSS/padding) |\n| --border-radius | `string` | [MDN](https://mdn.dev/CSS/border-radius) |\n| --border | `string` | [MDN](https://mdn.dev/CSS/border) |\n| --font-family | `string` | [MDN](https://mdn.dev/CSS/font-family) |\n| --white-space | `string` | [MDN](https://mdn.dev/CSS/white-space) |"
}
}
],
"exports": [
{
"kind": "js",
"name": "CodeBlock",
"declaration": {
"name": "CodeBlock",
"module": "/src/codeblock/codeblock.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "/src/codeblock/define.js",
"declarations": [],
"exports": []
},
{
"kind": "javascript-module",
"path": "/src/codeblock/index.js",
"declarations": [],
"exports": [
{
"kind": "js",
"name": "*",
"declaration": {
"name": "*",
"module": "home/runner/work/elements/elements/projects/code/src/codeblock/codeblock.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "/src/codeblock/languages/bash.js",
"declarations": [],
"exports": []
},
{
"kind": "javascript-module",
"path": "/src/codeblock/languages/css.js",
"declarations": [],
"exports": []
},
{
"kind": "javascript-module",
"path": "/src/codeblock/languages/go.js",
"declarations": [],
"exports": []
},
{
"kind": "javascript-module",
"path": "/src/codeblock/languages/html.js",
"declarations": [],
"exports": []
},
{
"kind": "javascript-module",
"path": "/src/codeblock/languages/javascript.js",
"declarations": [],
"exports": []
},
{
"kind": "javascript-module",
"path": "/src/codeblock/languages/json.js",
"declarations": [],
"exports": []
},
{
"kind": "javascript-module",
"path": "/src/codeblock/languages/markdown.js",
"declarations": [],
"exports": []
},
{
"kind": "javascript-module",
"path": "/src/codeblock/languages/python.js",
"declarations": [],
"exports": []
},
{
"kind": "javascript-module",
"path": "/src/codeblock/languages/toml.js",
"declarations": [],
"exports": []
},
{
"kind": "javascript-module",
"path": "/src/codeblock/languages/typescript.js",
"declarations": [],
"exports": []
},
{
"kind": "javascript-module",
"path": "/src/codeblock/languages/xml.js",
"declarations": [],
"exports": []
},
{
"kind": "javascript-module",
"path": "/src/codeblock/languages/yaml.js",
"declarations": [],
"exports": []
},
{
"kind": "javascript-module",
"path": "/src/index.js",
"declarations": [
{
"kind": "variable",
"name": "VERSION",
"type": {
"text": "string"
},
"default": "'0.0.0'"
}
],
"exports": [
{
"kind": "js",
"name": "VERSION",
"declaration": {
"name": "VERSION",
"module": "/src/index.js"
}
}
]
}
]
}