Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: specify @default undefined for undefined prop values #64

Merged
merged 4 commits into from
Jan 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
450 changes: 225 additions & 225 deletions integration/carbon/COMPONENT_INDEX.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions integration/carbon/types/Accordion/Accordion.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export interface AccordionProps extends AccordionSkeletonProps {

/**
* Specify the size of the accordion
* @default undefined
*/
size?: "sm" | "xl";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export interface AccordionSkeletonProps

/**
* Specify the size of the accordion
* @default undefined
*/
size?: "sm" | "xl";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export interface BreadcrumbItemProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["li"]> {
/**
* Set the `href` to use an anchor link
* @default undefined
*/
href?: string;

Expand Down
3 changes: 3 additions & 0 deletions integration/carbon/types/Button/Button.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,13 @@ export interface ButtonProps

/**
* Specify the icon from `carbon-icons-svelte` to render
* @default undefined
*/
icon?: typeof import("carbon-icons-svelte").CarbonIcon;

/**
* Specify the ARIA label for the button icon
* @default undefined
*/
iconDescription?: string;

Expand Down Expand Up @@ -76,6 +78,7 @@ export interface ButtonProps

/**
* Set the `href` to use an anchor link
* @default undefined
*/
href?: string;

Expand Down
1 change: 1 addition & 0 deletions integration/carbon/types/Button/ButtonSkeleton.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export interface ButtonSkeletonProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
/**
* Set the `href` to use an anchor link
* @default undefined
*/
href?: string;

Expand Down
1 change: 1 addition & 0 deletions integration/carbon/types/Checkbox/Checkbox.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ export interface CheckboxProps {

/**
* Specify the title attribute for the label element
* @default undefined
*/
title?: string;

Expand Down
3 changes: 3 additions & 0 deletions integration/carbon/types/CodeSnippet/CodeSnippet.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export interface CodeSnippetProps {
/**
* Set the code snippet text
* Alternatively, use the default slot (e.g., <CodeSnippet>{`code`}</CodeSnippet>)
* @default undefined
*/
code?: string;

Expand Down Expand Up @@ -54,11 +55,13 @@ export interface CodeSnippetProps {

/**
* Specify the ARIA label for the copy button icon
* @default undefined
*/
copyButtonDescription?: string;

/**
* Specify the ARIA label of the copy button
* @default undefined
*/
copyLabel?: string;

Expand Down
3 changes: 3 additions & 0 deletions integration/carbon/types/ComboBox/ComboBox.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ export interface ComboBoxProps

/**
* Set the size of the combobox
* @default undefined
*/
size?: "sm" | "xl";

Expand Down Expand Up @@ -93,6 +94,7 @@ export interface ComboBoxProps

/**
* Override the default translation ids
* @default undefined
*/
translateWithId?: (id: any) => string;

Expand All @@ -104,6 +106,7 @@ export interface ComboBoxProps

/**
* Specify a name attribute for the input
* @default undefined
*/
name?: string;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export interface ComposedModalProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Set the size of the composed modal
* @default undefined
*/
size?: "xs" | "sm" | "lg";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export interface ModalFooterProps

/**
* Specify a class for the primary button
* @default undefined
*/
primaryClass?: string;

Expand All @@ -28,6 +29,7 @@ export interface ModalFooterProps

/**
* Specify a class for the secondary button
* @default undefined
*/
secondaryClass?: string;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export interface ContentSwitcherProps

/**
* Specify the size of the content switcher
* @default undefined
*/
size?: "sm" | "xl";
}
Expand Down
1 change: 1 addition & 0 deletions integration/carbon/types/DataTable/DataTable.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ export interface DataTableProps {

/**
* Set the size of the data table
* @default undefined
*/
size?: "compact" | "short" | "tall";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export interface DataTableSkeletonProps

/**
* Set the size of the data table
* @default undefined
*/
size?: "compact" | "short" | "tall";

Expand Down
1 change: 1 addition & 0 deletions integration/carbon/types/DataTable/Table.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export interface TableProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["section"]> {
/**
* Set the size of the table
* @default undefined
*/
size?: "compact" | "short" | "tall";

Expand Down
1 change: 1 addition & 0 deletions integration/carbon/types/DatePicker/DatePicker.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export interface DatePickerProps

/**
* Specify the element to append the calendar to
* @default undefined
*/
appendTo?: HTMLElement;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export interface DatePickerInputProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Set the size of the input
* @default undefined
*/
size?: "sm" | "xl";

Expand Down Expand Up @@ -70,6 +71,7 @@ export interface DatePickerInputProps

/**
* Set a name for the input element
* @default undefined
*/
name?: string;

Expand Down
4 changes: 4 additions & 0 deletions integration/carbon/types/Dropdown/Dropdown.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ export interface DropdownProps

/**
* Specify the size of the dropdown field
* @default undefined
*/
size?: "sm" | "lg" | "xl";

Expand Down Expand Up @@ -103,11 +104,13 @@ export interface DropdownProps

/**
* Specify the list box label
* @default undefined
*/
label?: string;

/**
* Override the default translation ids
* @default undefined
*/
translateWithId?: (id: any) => string;

Expand All @@ -119,6 +122,7 @@ export interface DropdownProps

/**
* Specify a name attribute for the list box
* @default undefined
*/
name?: string;

Expand Down
6 changes: 6 additions & 0 deletions integration/carbon/types/Grid/Column.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,31 +45,37 @@ export interface ColumnProps

/**
* Specify the aspect ratio of the column
* @default undefined
*/
aspectRatio?: "2x1" | "16x9" | "9x16" | "1x2" | "4x3" | "3x4" | "1x1";

/**
* Set the small breakpoint
* @default undefined
*/
sm?: ColumnBreakpoint;

/**
* Set the medium breakpoint
* @default undefined
*/
md?: ColumnBreakpoint;

/**
* Set the large breakpoint
* @default undefined
*/
lg?: ColumnBreakpoint;

/**
* Set the extra large breakpoint
* @default undefined
*/
xlg?: ColumnBreakpoint;

/**
* Set the maximum breakpoint
* @default undefined
*/
max?: ColumnBreakpoint;
}
Expand Down
1 change: 1 addition & 0 deletions integration/carbon/types/Icon/Icon.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export interface IconProps
svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["svg"]> {
/**
* Specify the icon from `carbon-icons-svelte` to render
* @default undefined
*/
render?: typeof import("carbon-icons-svelte").CarbonIcon;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ export interface InlineLoadingProps

/**
* Set the loading description
* @default undefined
*/
description?: string;

/**
* Specify the ARIA label for the loading icon
* @default undefined
*/
iconDescription?: string;

Expand Down
2 changes: 2 additions & 0 deletions integration/carbon/types/Link/Link.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ export interface LinkProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["p"]> {
/**
* Specify the size of the link
* @default undefined
*/
size?: "sm" | "lg";

/**
* Specify the href value
* @default undefined
*/
href?: string;

Expand Down
1 change: 1 addition & 0 deletions integration/carbon/types/ListBox/ListBox.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export interface ListBoxProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Set the size of the list box
* @default undefined
*/
size?: "sm" | "xl";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export interface ListBoxSelectionProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Specify the number of selected items
* @default undefined
*/
selectionCount?: any;

Expand Down
4 changes: 4 additions & 0 deletions integration/carbon/types/Modal/Modal.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export interface ModalProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Set the size of the modal
* @default undefined
*/
size?: "xs" | "sm" | "lg";

Expand Down Expand Up @@ -34,16 +35,19 @@ export interface ModalProps

/**
* Specify the modal heading
* @default undefined
*/
modalHeading?: string;

/**
* Specify the modal label
* @default undefined
*/
modalLabel?: string;

/**
* Specify the ARIA label for the modal
* @default undefined
*/
modalAriaLabel?: string;

Expand Down
3 changes: 3 additions & 0 deletions integration/carbon/types/MultiSelect/MultiSelect.svelte.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ export interface MultiSelectProps

/**
* Set the size of the combobox
* @default undefined
*/
size?: "sm" | "lg" | "xl";

Expand Down Expand Up @@ -107,6 +108,7 @@ export interface MultiSelectProps

/**
* Override the default translation ids
* @default undefined
*/
translateWithId?: (id: any) => string;

Expand Down Expand Up @@ -166,6 +168,7 @@ export interface MultiSelectProps

/**
* Specify a name attribute for the select
* @default undefined
*/
name?: string;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ export interface NotificationButtonProps

/**
* Specify the icon from `carbon-icons-svelte` to render
* @default undefined
*/
icon?: typeof import("carbon-icons-svelte").CarbonIcon;

/**
* Specify the title of the icon
* @default undefined
*/
title?: string;

Expand Down
Loading