@tidy-ui/container
Version:
The versatile Container is your layout commander, adapting effortlessly to screen shifts and breakpoints. It comes in two modes: fluid, flexing its width with the screen for a dynamic arrangement of enclosed components; and fixed, aligning components sole
155 lines (154 loc) • 6.61 kB
JSON
[
{
"comment": "/**\n * The IContainerProps interface empowers you to customize the behavior and appearance of Containers within your user interface.\n * These Containers serve as versatile wrappers for your content, helping you achieve consistent and visually pleasing layouts.\n *\n * @interface IContainerProps\n * @type {IContainerProps}\n * @augments {HTMLAttributes<HTMLDivElement>}\n * @public\n * @since 0.47.0\n * @interface IContainerProps\n */",
"meta": {
"filename": "types.ts",
"lineno": 6,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/container/src",
"code": {}
},
"description": "<p>The IContainerProps interface empowers you to customize the behavior and appearance of Containers within your user interface.\nThese Containers serve as versatile wrappers for your content, helping you achieve consistent and visually pleasing layouts.</p>",
"kind": "interface",
"name": "IContainerProps",
"type": {
"names": [
"IContainerProps"
]
},
"augments": [
"HTMLAttributes<HTMLDivElement>"
],
"access": "public",
"since": "0.47.0",
"longname": "IContainerProps",
"scope": "global"
},
{
"comment": "/**\n * The gutter property allows you to establish a comfortable breathing space around your container content. By defining a string value, you can determine the left and right padding, ensuring your content remains nicely spaced and easy on the eyes.\n *\n * @type {string}\n * @default '1.5rem'\n * @public\n * @since 0.47.0\n * @name IContainerProps#gutter\n * @optional\n * @type {string}\n */",
"meta": {
"filename": "types.ts",
"lineno": 17,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/container/src",
"code": {}
},
"description": "<p>The gutter property allows you to establish a comfortable breathing space around your container content. By defining a string value, you can determine the left and right padding, ensuring your content remains nicely spaced and easy on the eyes.</p>",
"type": {
"names": [
"string"
]
},
"defaultvalue": "'1.5rem'",
"access": "public",
"since": "0.47.0",
"name": "gutter",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IContainerProps",
"longname": "IContainerProps#gutter",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * The isFixed property introduces responsiveness to your containers. When set to `true`, your container's maximum width will automatically adjust according to different device breakpoints. This ensures a seamless experience across various screen sizes.\n *\n * @type {boolean}\n * @default false\n * @public\n * @since 0.47.0\n * @name IContainerProps#isFixed\n * @optional\n * @type {boolean}\n */",
"meta": {
"filename": "types.ts",
"lineno": 28,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/container/src",
"code": {}
},
"description": "<p>The isFixed property introduces responsiveness to your containers. When set to <code>true</code>, your container's maximum width will automatically adjust according to different device breakpoints. This ensures a seamless experience across various screen sizes.</p>",
"type": {
"names": [
"boolean"
]
},
"defaultvalue": "false",
"access": "public",
"since": "0.47.0",
"name": "isFixed",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IContainerProps",
"longname": "IContainerProps#isFixed",
"scope": "instance",
"kind": "member",
"optional": true
},
{
"comment": "/**\n * The maxWidth property enables you to define the maximum width of your container explicitly. By utilizing the `TScreen` type, you can ensure that your container maintains a consistent width while catering to your specific layout requirements.\n *\n * @type {TScreen}\n * @public\n * @since 0.47.0\n * @name IContainerProps#maxWidth\n * @optional\n * @type {TScreen}\n */",
"meta": {
"filename": "types.ts",
"lineno": 39,
"columnno": 0,
"path": "/home/runner/work/tidy-ui/tidy-ui/packages/container/src",
"code": {}
},
"description": "<p>The maxWidth property enables you to define the maximum width of your container explicitly. By utilizing the <code>TScreen</code> type, you can ensure that your container maintains a consistent width while catering to your specific layout requirements.</p>",
"type": {
"names": [
"TScreen"
]
},
"access": "public",
"since": "0.47.0",
"name": "maxWidth",
"tags": [
{
"originalTitle": "optional",
"title": "optional",
"text": ""
}
],
"memberof": "IContainerProps",
"longname": "IContainerProps#maxWidth",
"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/container/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/container/src/types.ts"
]
}
]