mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-15 18:31:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

chore: use jsdoc to annotate props

Browse source
This commit is contained in:
Eric Liu 2020-07-24 22:35:20 -07:00
commit 8c1ffd4cb0
5 changed files with 51 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

18
src/Grid/Column.svelte
View file

@ -6,30 +6,28 @@
/**
* Aspect ratio of the column
* @type {("2x1" | "16x9" | "9x16" | "1x2" | "4x3" | "3x4" | "1x1")} [aspectRatio]
* @type {"2x1" | "16x9" | "9x16" | "1x2" | "4x3" | "3x4" | "1x1"} [aspectRatio]
*/
export let aspectRatio = undefined;
/**
* @typedef {(boolean | number)} ColumnSize
* @typedef {Object} ColumnSizeDescriptor
* @property {ColumnSize} [ColumnSizeDescriptor.span] Column size
* @property {number} [ColumnSizeDescriptor.offset] Column offset
* @typedef {boolean | number} ColumnSize
* @typedef {{span?: ColumnSize: offset: number}} ColumnSizeDescriptor
*/
/** @type {ColumnSize|ColumnSizeDescriptor} [sm] */
/** @type {ColumnSize | ColumnSizeDescriptor} [sm] */
export let sm = undefined;
/** @type {ColumnSize|ColumnSizeDescriptor} [md] */
/** @type {ColumnSize | ColumnSizeDescriptor} [md] */
export let md = undefined;
/** @type {ColumnSize|ColumnSizeDescriptor} [lg] */
/** @type {ColumnSize | ColumnSizeDescriptor} [lg] */
export let lg = undefined;
/** @type {ColumnSize|ColumnSizeDescriptor} [xlg] */
/** @type {ColumnSize | ColumnSizeDescriptor} [xlg] */
export let xlg = undefined;
/** @type {ColumnSize|ColumnSizeDescriptor} [max] */
/** @type {ColumnSize | ColumnSizeDescriptor} [max] */
export let max = undefined;
const breakpoints = ["sm", "md", "lg", "xlg", "max"];