@tidy-ui/border
Version:
The Border component is a versatile tool to enclose components or groups. It supports content qualification like text or Chips and can be positioned in all directions. Create borders with customizable densities and sharp edges. Infuse borders with colors
314 lines (313 loc) • 10.7 kB
JSON
[
{
"comment": "/**\n * Interface defining properties for configuring a Border component.\n *\n * @interface IBorderProps\n * @type {IBorderProps}\n * @augments {HTMLAttributes<HTMLDivElement>}\n * @public\n * @since 0.47.0\n * @interface IBorderProps\n */",
"meta": {
"filename": "types.ts",
"lineno": 6,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/border/src",
"code": {}
},
"description": "<p>Interface defining properties for configuring a Border component.</p>",
"kind": "interface",
"name": "IBorderProps",
"type": {
"names": [
"IBorderProps"
]
},
"augments": [
"HTMLAttributes<HTMLDivElement>"
],
"access": "public",
"since": "0.47.0",
"longname": "IBorderProps",
"scope": "global"
},
{
"comment": "/**\n * An optional property used to adjust the content placement within the border, supporting both positive and negative values.\n *\n * @type {number}\n * @public\n * @since 0.47.0\n * @name IBorderProps#align\n * @optional\n * @type {number}\n */",
"meta": {
"filename": "types.ts",
"lineno": 16,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/border/src",
"code": {}
},
"description": "<p>An optional property used to adjust the content placement within the border, supporting both positive and negative values.</p>",
"type": {
"names": [
"number"
]
},
"access": "public",
"since": "0.47.0",
"name": "align",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBorderProps",
"longname": "IBorderProps#align",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * An optional JSX element that resides within the border.\n *\n * @type {JSX.Element}\n * @public\n * @since 0.47.0\n * @name IBorderProps#content\n * @optional\n * @type {JSX.Element}\n */",
"meta": {
"filename": "types.ts",
"lineno": 26,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/border/src",
"code": {}
},
"description": "<p>An optional JSX element that resides within the border.</p>",
"type": {
"names": [
"JSX.Element"
]
},
"access": "public",
"since": "0.47.0",
"name": "content",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBorderProps",
"longname": "IBorderProps#content",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * An optional property specifying the border width.\n *\n * @type {string}\n * @default '1px'\n * @public\n * @since 0.47.0\n * @name IBorderProps#density\n * @optional\n * @type {string}\n */",
"meta": {
"filename": "types.ts",
"lineno": 36,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/border/src",
"code": {}
},
"description": "<p>An optional property specifying the border width.</p>",
"type": {
"names": [
"string"
]
},
"defaultvalue": "'1px'",
"access": "public",
"since": "0.47.0",
"name": "density",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBorderProps",
"longname": "IBorderProps#density",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * An optional property that determines whether sharp borders should be created.\n *\n * @type {boolean}\n * @default false\n * @public\n * @since 0.47.0\n * @name IBorderProps#isSharp\n * @optional\n * @type {boolean}\n */",
"meta": {
"filename": "types.ts",
"lineno": 47,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/border/src",
"code": {}
},
"description": "<p>An optional property that determines whether sharp borders should be created.</p>",
"type": {
"names": [
"boolean"
]
},
"defaultvalue": "false",
"access": "public",
"since": "0.47.0",
"name": "isSharp",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBorderProps",
"longname": "IBorderProps#isSharp",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * An optional property specifying the positioning of the `content` within the border.\n *\n * @type {TPositioning}\n * @default 'top-left'\n * @public\n * @since 0.47.0\n * @name IBorderProps#positioning\n * @optional\n * @type {TPositioning}\n */",
"meta": {
"filename": "types.ts",
"lineno": 58,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/border/src",
"code": {}
},
"description": "<p>An optional property specifying the positioning of the <code>content</code> within the border.</p>",
"type": {
"names": [
"TPositioning"
]
},
"defaultvalue": "'top-left'",
"access": "public",
"since": "0.47.0",
"name": "positioning",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBorderProps",
"longname": "IBorderProps#positioning",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * An optional property defining the shade of the border.\n *\n * @type {TShade}\n * @default 500\n * @public\n * @since 0.47.0\n * @name IBorderProps#shade\n * @optional\n * @type {TShade}\n */",
"meta": {
"filename": "types.ts",
"lineno": 69,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/border/src",
"code": {}
},
"description": "<p>An optional property defining the shade of the border.</p>",
"type": {
"names": [
"TShade"
]
},
"defaultvalue": "500",
"access": "public",
"since": "0.47.0",
"name": "shade",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBorderProps",
"longname": "IBorderProps#shade",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * An optional property specifying the color tone of the border.\n *\n * @type {TTone}\n * @default 'neutral'\n * @public\n * @since 0.47.0\n * @name IBorderProps#tone\n * @optional\n * @type {TTone}\n */",
"meta": {
"filename": "types.ts",
"lineno": 80,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/border/src",
"code": {}
},
"description": "<p>An optional property specifying the color tone of the border.</p>",
"type": {
"names": [
"TTone"
]
},
"defaultvalue": "'neutral'",
"access": "public",
"since": "0.47.0",
"name": "tone",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBorderProps",
"longname": "IBorderProps#tone",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * An optional property defining the border style.\n *\n * @type {TBorderStyle}\n * @default 'solid'\n * @public\n * @since 0.47.0\n * @name IBorderProps#variant\n * @optional\n * @type {TBorderStyle}\n */",
"meta": {
"filename": "types.ts",
"lineno": 91,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/border/src",
"code": {}
},
"description": "<p>An optional property defining the border style.</p>",
"type": {
"names": [
"TBorderStyle"
]
},
"defaultvalue": "'solid'",
"access": "public",
"since": "0.47.0",
"name": "variant",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IBorderProps",
"longname": "IBorderProps#variant",
"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/border/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/border/src/types.ts"
]
}
]