From 3129890c9c5f9045f9c0ef7e3360fcacd2538c93 Mon Sep 17 00:00:00 2001 From: Devin Fee Date: Thu, 13 Jun 2019 13:48:13 -0700 Subject: [PATCH] added (literal) indicator to documented props that are literals --- src/base/__docs__/generic.docs.mdx | 14 ++--- .../breadcrumb/__docs__/breadcrumb.docs.mdx | 22 ++++---- src/components/card/__docs__/card.docs.mdx | 8 +-- .../dropdown/__docs__/dropdown.docs.mdx | 28 +++++----- src/components/level/__docs__/level.docs.mdx | 16 +++--- src/components/media/__docs__/media.docs.mdx | 10 ++-- .../message/__docs__/message.docs.mdx | 12 ++--- .../navbar/__docs__/navbar.docs.mdx | 8 +-- .../pagination/__docs__/pagination.docs.mdx | 6 +-- src/components/tab/__docs__/tab.docs.mdx | 24 ++++----- src/elements/button/__docs__/button.docs.mdx | 10 ++-- .../container/__docs__/container.docs.mdx | 10 ++-- .../content/__docs__/content.docs.mdx | 14 ++--- src/elements/form/__docs__/file.docs.mdx | 24 ++++----- src/elements/form/__docs__/form.docs.mdx | 12 ++--- src/elements/form/__docs__/input.docs.mdx | 26 ++++----- src/elements/form/__docs__/select.docs.mdx | 20 +++---- src/elements/form/__docs__/textarea.docs.mdx | 18 +++---- src/elements/icon/__docs__/icon.docs.mdx | 6 +-- src/elements/image/__docs__/image.docs.mdx | 2 +- .../__docs__/notification.docs.mdx | 8 +-- src/elements/other/__docs__/other.docs.mdx | 8 +-- .../progress/__docs__/progress.docs.mdx | 4 +- src/elements/tag/__docs__/tag.docs.mdx | 6 +-- src/elements/title/__docs__/title.docs.mdx | 12 ++--- src/extensions/__docs__/badge.docs.mdx | 4 +- .../divider/__docs__/divider.docs.mdx | 2 +- .../page-loader/__docs__/page-loader.docs.mdx | 4 +- src/grid/columns/__docs__/columns.docs.mdx | 54 +++++++++---------- src/grid/tiles/__docs__/tile.docs.mdx | 16 +++--- src/layout/hero/__docs__/hero.docs.mdx | 14 ++--- src/layout/section/__docs__/section.docs.mdx | 8 +-- 32 files changed, 215 insertions(+), 215 deletions(-) diff --git a/src/base/__docs__/generic.docs.mdx b/src/base/__docs__/generic.docs.mdx index 8007a1b1..c985e698 100644 --- a/src/base/__docs__/generic.docs.mdx +++ b/src/base/__docs__/generic.docs.mdx @@ -85,7 +85,7 @@ Here is an example of rendering as a `` component, and passing thr }, pull: { description: "moves an element to the left or right", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(DEFAULTS.floatPulledAlignments), }, }} @@ -119,7 +119,7 @@ Here is an example of rendering as a `` component, and passing thr props={{ backgroundColor: { description: "sets the background color", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable([...DEFAULTS.colors, ...DEFAULTS.shades]), }, italic: { @@ -128,27 +128,27 @@ Here is an example of rendering as a `` component, and passing thr }, textAlign: { description: "sets the alignment of the text", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(DEFAULTS.textAlignments), }, textColor: { description: "sets the text color", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable([...DEFAULTS.colors, ...DEFAULTS.shades]), }, textSize: { description: "sets the text size", - typeName: "string", + typeName: "number (literal)", typeTip: mapEnumerable(DEFAULTS.textSizes), }, textTransform: { description: "alters the text capitalization", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(DEFAULTS.textSizes), }, textWeight: { description: "sets the text weight", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(DEFAULTS.textWeights), }, }} diff --git a/src/components/breadcrumb/__docs__/breadcrumb.docs.mdx b/src/components/breadcrumb/__docs__/breadcrumb.docs.mdx index 852f360e..7292226f 100644 --- a/src/components/breadcrumb/__docs__/breadcrumb.docs.mdx +++ b/src/components/breadcrumb/__docs__/breadcrumb.docs.mdx @@ -8,7 +8,7 @@ import { faBook, faHome, faPuzzlePiece, - faThumbsUp + faThumbsUp, } from "@fortawesome/free-solid-svg-icons"; import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"; import { Playground } from "docz"; @@ -16,7 +16,7 @@ import { Playground } from "docz"; import { ForwardRefAsExoticComponentDoc, OptionBlock, - mapEnumerable + mapEnumerable, } from "src/__docs__/components"; import { DEFAULTS } from "src/base/helpers/variables"; import { Block, Title, Icon } from "src/elements"; @@ -154,19 +154,19 @@ Use the `size` prop on `` to specify the size of the breadcrumbs. props={{ align: { description: "set the breadcrumb group's alignment", - typeName: "string", - typeTip: mapEnumerable(BREADCRUMB_DEFAULTS.alignments) + typeName: "string (literal)", + typeTip: mapEnumerable(BREADCRUMB_DEFAULTS.alignments), }, separator: { description: "set the breadcrumb group's separator", - typeName: "string", - typeTip: mapEnumerable(BREADCRUMB_DEFAULTS.separators) + typeName: "string (literal)", + typeTip: mapEnumerable(BREADCRUMB_DEFAULTS.separators), }, size: { description: "set the breadcrumb group's size", - typeName: "string", - typeTip: mapEnumerable(BREADCRUMB_DEFAULTS.sizes) - } + typeName: "string (literal)", + typeTip: mapEnumerable(BREADCRUMB_DEFAULTS.sizes), + }, }} /> @@ -176,7 +176,7 @@ Use the `size` prop on `` to specify the size of the breadcrumbs. props={{ active: { description: "marks the breadcrumb as active", - typeName: "boolean" - } + typeName: "boolean", + }, }} /> diff --git a/src/components/card/__docs__/card.docs.mdx b/src/components/card/__docs__/card.docs.mdx index f5c09ef4..0f00a697 100644 --- a/src/components/card/__docs__/card.docs.mdx +++ b/src/components/card/__docs__/card.docs.mdx @@ -10,7 +10,7 @@ import { Playground } from "docz"; import { ForwardRefAsExoticComponentDoc, - mapEnumerable + mapEnumerable, } from "src/__docs__/components"; import { DEFAULTS } from "src/base/helpers/variables"; import { Media } from "src/components"; @@ -198,9 +198,9 @@ An all-around flexible and composable component. props={{ align: { description: "set the alignment of the title", - typeName: "string", - typeTip: mapEnumerable(CARD_HEADER_TITLE_DEFAULTS.alignments) - } + typeName: "string (literal)", + typeTip: mapEnumerable(CARD_HEADER_TITLE_DEFAULTS.alignments), + }, }} /> diff --git a/src/components/dropdown/__docs__/dropdown.docs.mdx b/src/components/dropdown/__docs__/dropdown.docs.mdx index 036b3828..c0e1ae54 100644 --- a/src/components/dropdown/__docs__/dropdown.docs.mdx +++ b/src/components/dropdown/__docs__/dropdown.docs.mdx @@ -10,7 +10,7 @@ import { Playground } from "docz"; import { ForwardRefAsExoticComponentDoc, - mapEnumerable + mapEnumerable, } from "src/__docs__/components"; import { DEFAULTS } from "src/base/helpers/variables"; import { Level } from "src/components"; @@ -276,26 +276,26 @@ Use the `up` prop on `` for the menu to appear **above** the ` @@ -315,12 +315,12 @@ Use the `up` prop on `` for the menu to appear **above** the ` void" - } + typeName: "(event: React.MouseEvent) => void", + }, }} /> @@ -335,11 +335,11 @@ Use the `up` prop on `` for the menu to appear **above** the ` void" - } + typeName: "(event: React.MouseEvent) => void", + }, }} /> diff --git a/src/components/level/__docs__/level.docs.mdx b/src/components/level/__docs__/level.docs.mdx index 9e32a029..6f389f9a 100644 --- a/src/components/level/__docs__/level.docs.mdx +++ b/src/components/level/__docs__/level.docs.mdx @@ -8,7 +8,7 @@ import { Playground } from "docz"; import { ForwardRefAsExoticComponentDoc, - mapEnumerable + mapEnumerable, } from "src/__docs__/components"; import { DEFAULTS } from "src/base/helpers/variables"; import { Generic } from "src/base"; @@ -19,7 +19,7 @@ import { Field, Heading, Input, - Title + Title, } from "src/elements"; import { Level } from "../level"; import { LEVEL_ITEM_DEFAULTS } from "../level-item"; @@ -223,9 +223,9 @@ For example, for a responsive size greater than **mobile** (up to 768px), these breakpoint: { description: 'the responsive size at which the level is vertical (without overriding Bulma SASS, only "mobile" is supported)', - typeName: "string", - typeTip: mapEnumerable(DEFAULTS.breakpoints) - } + typeName: "string (literal)", + typeTip: mapEnumerable(DEFAULTS.breakpoints), + }, }} /> @@ -236,8 +236,8 @@ For example, for a responsive size greater than **mobile** (up to 768px), these props={{ align: { description: "the side of the level is placed", - typeName: "string", - typeTip: mapEnumerable(LEVEL_ITEM_DEFAULTS.alignments) - } + typeName: "string (literal)", + typeTip: mapEnumerable(LEVEL_ITEM_DEFAULTS.alignments), + }, }} /> diff --git a/src/components/media/__docs__/media.docs.mdx b/src/components/media/__docs__/media.docs.mdx index 4479fe7a..2fd36bbf 100644 --- a/src/components/media/__docs__/media.docs.mdx +++ b/src/components/media/__docs__/media.docs.mdx @@ -10,7 +10,7 @@ import { Playground } from "docz"; import { ForwardRefAsExoticComponentDoc, - mapEnumerable + mapEnumerable, } from "src/__docs__/components"; import { DEFAULTS } from "src/base/helpers/variables"; import { Level } from "src/components"; @@ -24,7 +24,7 @@ import { Icon, Image, Label, - Textarea + Textarea, } from "src/elements"; import { Media } from "../media"; import { MEDIA_ITEM_DEFAULTS } from "../media-item"; @@ -256,8 +256,8 @@ You can nest `` objects up to 3 levels deep (without extending Bulma's SA props={{ align: { description: "change the position of the item inside the media container", - typeName: "string", - typeTip: mapEnumerable(MEDIA_ITEM_DEFAULTS.alignments) - } + typeName: "string (literal)", + typeTip: mapEnumerable(MEDIA_ITEM_DEFAULTS.alignments), + }, }} /> diff --git a/src/components/message/__docs__/message.docs.mdx b/src/components/message/__docs__/message.docs.mdx index 05593abb..2ad693ff 100644 --- a/src/components/message/__docs__/message.docs.mdx +++ b/src/components/message/__docs__/message.docs.mdx @@ -9,7 +9,7 @@ import { Playground } from "docz"; import { ForwardRefAsExoticComponentDoc, mapEnumerable, - OptionBlock + OptionBlock, } from "src/__docs__/components"; import { DEFAULTS } from "src/base/helpers/variables"; import { Delete } from "src/elements"; @@ -134,14 +134,14 @@ Use the `size` prop on `` to set the size. props={{ color: { description: "set the message's color", - typeName: "string", - typeTip: mapEnumerable(DEFAULTS.colors) + typeName: "string (literal)", + typeTip: mapEnumerable(DEFAULTS.colors), }, size: { description: "set the message's size", - typeName: "string", - typeTip: mapEnumerable(MESSAGE_DEFAULTS.sizes) - } + typeName: "string (literal)", + typeTip: mapEnumerable(MESSAGE_DEFAULTS.sizes), + }, }} /> diff --git a/src/components/navbar/__docs__/navbar.docs.mdx b/src/components/navbar/__docs__/navbar.docs.mdx index 14d6ede7..f8d23e42 100644 --- a/src/components/navbar/__docs__/navbar.docs.mdx +++ b/src/components/navbar/__docs__/navbar.docs.mdx @@ -848,7 +848,7 @@ Use the `color` prop of the `` to change the color. }, color: { description: "set the navbar's color", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(DEFAULTS.colors), }, document: { @@ -858,7 +858,7 @@ Use the `color` prop of the `` to change the color. }, fixed: { description: "fix the position to the top or bottom", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(NAVBAR_DEFAULTS.fixedAlignments), }, managed: { @@ -902,7 +902,7 @@ Use the `color` prop of the `` to change the color. props={{ align: { description: "align the menu to the left or right", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(NAVBAR_DROPDOWN_DEFAULTS.alignments), }, boxed: { @@ -990,7 +990,7 @@ Use the `color` prop of the `` to change the color. description: "set the content in the left or right side of the dropdown menu", required: true, - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(NAVBAR_SEGMENT_DEFAULTS.alignments), }, }} diff --git a/src/components/pagination/__docs__/pagination.docs.mdx b/src/components/pagination/__docs__/pagination.docs.mdx index e074aa01..35086292 100644 --- a/src/components/pagination/__docs__/pagination.docs.mdx +++ b/src/components/pagination/__docs__/pagination.docs.mdx @@ -174,7 +174,7 @@ Use the `size` prop on `` to change the size. props={{ align: { description: "change the pagination's alignment of pagination items", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(PAGINATION_DEFAULTS.alignments), }, rounded: { @@ -183,7 +183,7 @@ Use the `size` prop on `` to change the size. }, size: { description: "change the pagination's size", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(PAGINATION_DEFAULTS.sizes), }, }} @@ -226,7 +226,7 @@ Use the `size` prop on `` to change the size. description: "set the step as next or previous (positioning changes with pagination's align prop", required: true, - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(PAGINATION_STEP_DEFAULTS.alignments), }, }} diff --git a/src/components/tab/__docs__/tab.docs.mdx b/src/components/tab/__docs__/tab.docs.mdx index 8f0638ec..a551fc15 100644 --- a/src/components/tab/__docs__/tab.docs.mdx +++ b/src/components/tab/__docs__/tab.docs.mdx @@ -11,7 +11,7 @@ import { faFileAlt, faFilm, faImage, - faMusic + faMusic, } from "@fortawesome/free-solid-svg-icons"; import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"; import { Playground } from "docz"; @@ -19,7 +19,7 @@ import { Playground } from "docz"; import { ForwardRefAsExoticComponentDoc, mapEnumerable, - OptionBlock + OptionBlock, } from "src/__docs__/components"; import { DEFAULTS } from "src/base/helpers/variables"; import { Block, Icon, Title } from "src/elements"; @@ -323,8 +323,8 @@ And here are **fullwidth toggle** tabs: props={{ active: { description: "set the tab as currently active", - typeName: "boolean" - } + typeName: "boolean", + }, }} /> @@ -335,23 +335,23 @@ And here are **fullwidth toggle** tabs: props={{ align: { description: "set the tab group's alignment", - typeName: "string", - typeTip: mapEnumerable(TAB_GROUP_DEFAULTS.alignments) + typeName: "string (literal)", + typeTip: mapEnumerable(TAB_GROUP_DEFAULTS.alignments), }, fullsize: { description: "expand the tab group to consume all available horizontal space", - typeName: "boolean" + typeName: "boolean", }, kind: { description: "set the tab group's styling", - typeName: "string", - typeTip: mapEnumerable(TAB_GROUP_DEFAULTS.kinds) + typeName: "string (literal)", + typeTip: mapEnumerable(TAB_GROUP_DEFAULTS.kinds), }, size: { description: "set the tab group's size", - typeName: "string", - typeTip: mapEnumerable(TAB_GROUP_DEFAULTS.sizes) - } + typeName: "string (literal)", + typeTip: mapEnumerable(TAB_GROUP_DEFAULTS.sizes), + }, }} /> diff --git a/src/elements/button/__docs__/button.docs.mdx b/src/elements/button/__docs__/button.docs.mdx index fc203168..58f324ac 100644 --- a/src/elements/button/__docs__/button.docs.mdx +++ b/src/elements/button/__docs__/button.docs.mdx @@ -520,7 +520,7 @@ You should use the `selected` prop of the button to ensure it's _above_ it's sib props={{ color: { description: "the color of the button", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(DEFAULTS.colors), }, fullwidth: { @@ -545,12 +545,12 @@ You should use the `selected` prop of the button to ensure it's _above_ it's sib }, size: { description: "the size of the button", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(BUTTON_DEFAULTS.sizes), }, state: { description: "the state of the button", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(BUTTON_DEFAULTS.states), }, static: { @@ -571,7 +571,7 @@ You should use the `selected` prop of the button to ensure it's _above_ it's sib props={{ align: { description: "the alignment of the button group", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(BUTTON_GROUP_DEFAULTS.alignments), }, hasAddons: { @@ -580,7 +580,7 @@ You should use the `selected` prop of the button to ensure it's _above_ it's sib }, size: { description: "set the size of children buttons", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(BUTTON_GROUP_DEFAULTS.sizes), }, }} diff --git a/src/elements/container/__docs__/container.docs.mdx b/src/elements/container/__docs__/container.docs.mdx index ee18de1e..572a0cee 100644 --- a/src/elements/container/__docs__/container.docs.mdx +++ b/src/elements/container/__docs__/container.docs.mdx @@ -10,7 +10,7 @@ import { Frame, ForwardRefAsExoticComponentDoc, mapEnumerable, - OptionBlock + OptionBlock, } from "src/__docs__/components"; import { DEFAULTS } from "src/base/helpers/variables"; import { Notification } from "src/elements"; @@ -70,13 +70,13 @@ Use the `fluid` prop for the container to fit horizontally with padding. breakpoint: { description: "the responsive size at which this container is no longer fullwidth", - typeName: "string", - typeTip: mapEnumerable(DEFAULTS.breakpoints) + typeName: "string (literal)", + typeTip: mapEnumerable(DEFAULTS.breakpoints), }, fluid: { description: "whether the container expands to fit horizontally with padding", - typeName: "boolean" - } + typeName: "boolean", + }, }} /> diff --git a/src/elements/content/__docs__/content.docs.mdx b/src/elements/content/__docs__/content.docs.mdx index 6e3865c4..647bc5c8 100644 --- a/src/elements/content/__docs__/content.docs.mdx +++ b/src/elements/content/__docs__/content.docs.mdx @@ -10,7 +10,7 @@ import { Frame, ForwardRefAsExoticComponentDoc, mapEnumerable, - OptionBlock + OptionBlock, } from "src/__docs__/components"; import { Title } from "src/elements"; import { Content, CONTENT_DEFAULTS } from "../content"; @@ -109,9 +109,9 @@ Use the `type` prop on `` to control the bullet styling of props={{ size: { description: "changes the font-size", - typeName: "string", - typeTip: mapEnumerable(CONTENT_DEFAULTS.sizes) - } + typeName: "string (literal)", + typeTip: mapEnumerable(CONTENT_DEFAULTS.sizes), + }, }} /> @@ -122,9 +122,9 @@ Use the `type` prop on `` to control the bullet styling of props={{ type: { description: "changes the item marker of the list", - typeName: "string", - typeTip: mapEnumerable(CONTENT_ORDERED_LIST_DEFAULTS.types) - } + typeName: "string (literal)", + typeTip: mapEnumerable(CONTENT_ORDERED_LIST_DEFAULTS.types), + }, }} /> diff --git a/src/elements/form/__docs__/file.docs.mdx b/src/elements/form/__docs__/file.docs.mdx index d399487b..2be930ab 100644 --- a/src/elements/form/__docs__/file.docs.mdx +++ b/src/elements/form/__docs__/file.docs.mdx @@ -11,7 +11,7 @@ import { Playground } from "docz"; import { ForwardRefAsExoticComponentDoc, mapEnumerable, - OptionBlock + OptionBlock, } from "src/__docs__/components"; import { DEFAULTS } from "src/base/helpers/variables"; import { Content, Notification } from "src/elements"; @@ -181,7 +181,7 @@ Use the `color` prop of `` to change the color. { boxed: false, hasName: false, color: "primary" }, { boxed: false, hasName: true, color: "info" }, { boxed: true, hasName: false, color: "warning" }, - { boxed: true, hasName: true, color: "danger" } + { boxed: true, hasName: true, color: "danger" }, ]; return permutations.map(({ boxed, color, hasName }, i) => ( @@ -396,31 +396,31 @@ This implementation takes the same props as ``, but allows for actual sele props={{ align: { description: "set the file input's alignment", - typeName: "string", - typeTip: mapEnumerable(FILE_DEFAULTS.alignments) + typeName: "string (literal)", + typeTip: mapEnumerable(FILE_DEFAULTS.alignments), }, boxed: { description: "use a boxed layout for the file input", - typeName: "boolean" + typeName: "boolean", }, color: { description: "set the file input's color", - typeName: "string", - typeTip: mapEnumerable(DEFAULTS.colors) + typeName: "string (literal)", + typeTip: mapEnumerable(DEFAULTS.colors), }, fullwidth: { description: "expand the input to occupy all available horizontal space", - typeName: "boolean" + typeName: "boolean", }, hasName: { description: "whether to show the file's name", - typeName: "boolean" + typeName: "boolean", }, size: { description: "set the file input's size", - typeName: "string", - typeTip: mapEnumerable(FILE_DEFAULTS.sizes) - } + typeName: "string (literal)", + typeTip: mapEnumerable(FILE_DEFAULTS.sizes), + }, }} /> diff --git a/src/elements/form/__docs__/form.docs.mdx b/src/elements/form/__docs__/form.docs.mdx index 189213b2..24cfaeed 100644 --- a/src/elements/form/__docs__/form.docs.mdx +++ b/src/elements/form/__docs__/form.docs.mdx @@ -845,7 +845,7 @@ Use the `disabled` prop on `
` to set all child fields as disabled. }, size: { description: "change the control's size", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(CONTROL_DEFAULTS.sizes), }, }} @@ -858,7 +858,7 @@ Use the `disabled` prop on `
` to set all child fields as disabled. props={{ align: { description: "the alignment of the field", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(FIELD_DEFAULTS.alignments), }, expanded: { @@ -871,7 +871,7 @@ Use the `disabled` prop on `
` to set all child fields as disabled. }, kind: { description: "support addons or groups", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(FIELD_DEFAULTS.kinds), }, multiline: { @@ -898,7 +898,7 @@ Use the `disabled` prop on `
` to set all child fields as disabled. props={{ size: { description: "preserve vertical alignment with the ", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(FIELD_LABEL_DEFAULTS.sizes), }, }} @@ -923,7 +923,7 @@ Use the `disabled` prop on `
` to set all child fields as disabled. props={{ color: { description: "the help's color", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(DEFAULTS.colors), }, }} @@ -940,7 +940,7 @@ Use the `disabled` prop on `
` to set all child fields as disabled. }, size: { description: "the label's size", - typeName: "string", + typeName: "string (literal)", typeTip: mapEnumerable(LABEL_DEFAULTS.sizes), }, }} diff --git a/src/elements/form/__docs__/input.docs.mdx b/src/elements/form/__docs__/input.docs.mdx index 51bc9149..ddff8220 100644 --- a/src/elements/form/__docs__/input.docs.mdx +++ b/src/elements/form/__docs__/input.docs.mdx @@ -11,7 +11,7 @@ import { Playground } from "docz"; import { ForwardRefAsExoticComponentDoc, mapEnumerable, - OptionBlock + OptionBlock, } from "src/__docs__/components"; import { DEFAULTS } from "src/base/helpers/variables"; import { Icon } from "src/elements"; @@ -268,36 +268,36 @@ If the control contains an icon, it will remain **centered** regardless of the s props={{ color: { description: "change the input's color", - typeName: "string", - typeTip: mapEnumerable(DEFAULTS.colors) + typeName: "string (literal)", + typeTip: mapEnumerable(DEFAULTS.colors), }, readOnly: { description: "make the input read-only", - typeName: "boolean" + typeName: "boolean", }, rounded: { description: "round the edges of the input", - typeName: "boolean" + typeName: "boolean", }, size: { description: "change the input's size", - typeName: "string", - typeTip: mapEnumerable(INPUT_DEFAULTS.sizes) + typeName: "string (literal)", + typeTip: mapEnumerable(INPUT_DEFAULTS.sizes), }, state: { description: "change the input's state", - typeName: "string", - typeTip: mapEnumerable(INPUT_DEFAULTS.states) + typeName: "string (literal)", + typeTip: mapEnumerable(INPUT_DEFAULTS.states), }, static: { description: "remove the background, border, shadow and horizontal padding", - typeName: "boolean" + typeName: "boolean", }, type: { description: "set the input's type", - typeName: "string", - typeTip: mapEnumerable(INPUT_DEFAULTS.types) - } + typeName: "string (literal)", + typeTip: mapEnumerable(INPUT_DEFAULTS.types), + }, }} /> diff --git a/src/elements/form/__docs__/select.docs.mdx b/src/elements/form/__docs__/select.docs.mdx index 333748b4..e465149d 100644 --- a/src/elements/form/__docs__/select.docs.mdx +++ b/src/elements/form/__docs__/select.docs.mdx @@ -11,7 +11,7 @@ import { Playground } from "docz"; import { ForwardRefAsExoticComponentDoc, mapEnumerable, - OptionBlock + OptionBlock, } from "src/__docs__/components"; import { DEFAULTS } from "src/base/helpers/variables"; import { Icon } from "src/elements"; @@ -232,27 +232,27 @@ The size of the `