@tidy-ui/code
Version:
The Code component elegantly displays preformatted text, such as JavaScript code, on your webpage while maintaining its original format. With a convenient copy-to-clipboard button and seamless theming, sharing and styling code has never been smoother.
92 lines (91 loc) • 3.57 kB
JSON
[
{
"comment": "/**\n * The ICodeProps interface is designed to provide you with fine-grained control over the appearance and behavior of a code snippet component.\n *\n * @interface ICodeProps\n * @type {ICodeProps}\n * @augments {HTMLAttributes<HTMLDivElement>}\n * @public\n * @since 0.47.0\n * @interface ICodeProps\n */",
"meta": {
"filename": "types.ts",
"lineno": 6,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/code/src",
"code": {}
},
"description": "<p>The ICodeProps interface is designed to provide you with fine-grained control over the appearance and behavior of a code snippet component.</p>",
"kind": "interface",
"name": "ICodeProps",
"type": {
"names": [
"ICodeProps"
]
},
"augments": [
"HTMLAttributes<HTMLDivElement>"
],
"access": "public",
"since": "0.47.0",
"longname": "ICodeProps",
"scope": "global"
},
{
"comment": "/**\n * The canCopy property enables you to control the presence of a convenient copy-to-clipboard button within the code snippet component.\n * When canCopy is set to true (the default), users can easily copy the code snippet to their clipboard with a single click.\n * However, if you wish to restrict this functionality, you can set canCopy to false.\n *\n * @type {boolean}\n * @default true\n * @public\n * @since 0.47.0\n * @name ICodeProps#canCopy\n * @optional\n * @type {boolean}\n */",
"meta": {
"filename": "types.ts",
"lineno": 16,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/code/src",
"code": {}
},
"description": "<p>The canCopy property enables you to control the presence of a convenient copy-to-clipboard button within the code snippet component.\nWhen canCopy is set to true (the default), users can easily copy the code snippet to their clipboard with a single click.\nHowever, if you wish to restrict this functionality, you can set canCopy to false.</p>",
"type": {
"names": [
"boolean"
]
},
"defaultvalue": "true",
"access": "public",
"since": "0.47.0",
"name": "canCopy",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "ICodeProps",
"longname": "ICodeProps#canCopy",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "",
"meta": {
"range": [
6,
16
],
"filename": "types.ts",
"lineno": 1,
"columnno": 6,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/code/src",
"code": {
"id": "astnode100000003",
"name": "_____a",
"type": "Literal",
"value": 1
}
},
"undocumented": true,
"name": "_____a",
"longname": "_____a",
"kind": "constant",
"scope": "global",
"params": []
},
{
"kind": "package",
"longname": "package:undefined",
"files": [
"/home/runner/work/tidy-ui/tidy-ui/packages/code/src/types.ts"
]
}
]