breaking: remove deprecated props and components (#1191)

This commit is contained in:
metonym 2022-03-27 08:21:58 -07:00 committed by GitHub
commit 21714d0e3a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
55 changed files with 127 additions and 1823 deletions

View file

@ -38,12 +38,6 @@ export interface ButtonProps
*/
isSelected?: boolean;
/**
* Set to `true` for the icon-only variant
* @default false
*/
hasIconOnly?: boolean;
/**
* Specify the icon to render
* @default undefined
@ -57,8 +51,8 @@ export interface ButtonProps
iconDescription?: string;
/**
* Set the alignment of the tooltip relative to the icon
* `hasIconOnly` must be set to `true`
* Set the alignment of the tooltip relative to the icon.
* Only applies to icon-only buttons
* @default "center"
*/
tooltipAlignment?: "start" | "center" | "end";

View file

@ -14,11 +14,6 @@ export interface ButtonSkeletonProps
* @default "default"
*/
size?: "default" | "field" | "small" | "lg" | "xl";
/**
* @default false
*/
small?: boolean;
}
export default class ButtonSkeleton extends SvelteComponentTyped<

View file

@ -9,12 +9,6 @@ export interface ContentSwitcherProps
*/
selectedIndex?: number;
/**
* Set to `true` to enable the light variant
* @default false
*/
light?: boolean;
/**
* Specify the size of the content switcher
* @default undefined

View file

@ -1,32 +0,0 @@
/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
export interface CopyProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["button"]> {
/**
* Set the feedback text shown after clicking the button
* @default "Copied!"
*/
feedback?: string;
/**
* Set the timeout duration (ms) to display feedback text
* @default 2000
*/
feedbackTimeout?: number;
/**
* Obtain a reference to the button HTML element
* @default null
*/
ref?: null | HTMLButtonElement;
}
export default class Copy extends SvelteComponentTyped<
CopyProps,
{
click: WindowEventMap["click"];
animationend: WindowEventMap["animationend"];
},
{ default: {} }
> {}

View file

@ -21,12 +21,6 @@ export interface TableProps
*/
useStaticWidth?: boolean;
/**
* Set to `true` for the bordered variant
* @default false
*/
shouldShowBorder?: boolean;
/**
* Set to `true` for the sortable variant
* @default false

View file

@ -1,34 +0,0 @@
/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
import { IconSkeletonProps } from "./IconSkeleton.svelte";
export interface IconProps
extends IconSkeletonProps,
svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["svg"]> {
/**
* Specify the icon to render
* @default undefined
*/
render?: typeof import("svelte").SvelteComponent;
/**
* Set to `true` to display the skeleton state
* @default false
*/
skeleton?: boolean;
}
/**
* @deprecated This component is deprecated.
* Use icons from "carbon-icons-svelte" instead.
*/
export default class Icon extends SvelteComponentTyped<
IconProps,
{
click: WindowEventMap["click"];
mouseover: WindowEventMap["mouseover"];
mouseenter: WindowEventMap["mouseenter"];
mouseleave: WindowEventMap["mouseleave"];
},
{}
> {}

View file

@ -1,25 +0,0 @@
/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
export interface IconSkeletonProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Set the size of the icon
* @default 16
*/
size?: number;
}
/**
* @deprecated This component is deprecated.
*/
export default class IconSkeleton extends SvelteComponentTyped<
IconSkeletonProps,
{
click: WindowEventMap["click"];
mouseover: WindowEventMap["mouseover"];
mouseenter: WindowEventMap["mouseenter"];
mouseleave: WindowEventMap["mouseleave"];
},
{}
> {}

View file

@ -1,37 +0,0 @@
/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
export interface NotificationTextDetailsProps {
/**
* Set the type of notification
* @default "toast"
*/
notificationType?: "toast" | "inline";
/**
* Specify the title text
* @default "Title"
*/
title?: string;
/**
* Specify the subtitle text
* @default ""
*/
subtitle?: string;
/**
* Specify the caption text
* @default "Caption"
*/
caption?: string;
}
/**
* @deprecated This component is deprecated.
*/
export default class NotificationTextDetails extends SvelteComponentTyped<
NotificationTextDetailsProps,
{},
{ default: {} }
> {}

View file

@ -48,12 +48,6 @@ export interface NumberInputProps
*/
readonly?: boolean;
/**
* Set to `true` to enable the mobile variant
* @default false
*/
mobile?: boolean;
/**
* Set to `true` to allow for an empty value
* @default false

View file

@ -8,11 +8,6 @@ export interface SearchProps {
*/
value?: any;
/**
* @default false
*/
small?: boolean;
/**
* Specify the size of the search input
* @default "xl"

View file

@ -3,11 +3,6 @@ import { SvelteComponentTyped } from "svelte";
export interface SearchSkeletonProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* @default false
*/
small?: boolean;
/**
* Specify the size of the search input
* @default "xl"

View file

@ -9,12 +9,6 @@ export interface StructuredListProps
*/
selected?: string;
/**
* Set to `true` to use the bordered variant
* @default false
*/
border?: boolean;
/**
* Set to `true` to use the condensed variant
* @default false

View file

@ -8,12 +8,6 @@ export interface StructuredListSkeletonProps
* @default 5
*/
rows?: number;
/**
* Set to `true` to use the bordered variant
* @default false
*/
border?: boolean;
}
export default class StructuredListSkeleton extends SvelteComponentTyped<

View file

@ -27,11 +27,6 @@ export interface TimePickerSelectProps
*/
labelText?: string;
/**
* @default true
*/
hideLabel?: boolean;
/**
* Set an id for the select element
* @default "ccs-" + Math.random().toString(36)

View file

@ -1,66 +0,0 @@
/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
export interface ToggleSmallProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Set to `true` to toggle the checkbox input
* @default false
*/
toggled?: boolean;
/**
* Set to `true` to disable checkbox input
* @default false
*/
disabled?: boolean;
/**
* Specify the label for the untoggled state
* @default "Off"
*/
labelA?: string;
/**
* Specify the label for the toggled state
* @default "On"
*/
labelB?: string;
/**
* Specify the label text
* @default ""
*/
labelText?: string;
/**
* Set an id for the input element
* @default "ccs-" + Math.random().toString(36)
*/
id?: string;
/**
* Specify a name attribute for the checkbox input
* @default undefined
*/
name?: string;
}
/**
* @deprecated This component is deprecated.
* Use`<Toggle size="sm" />` instead.
*/
export default class ToggleSmall extends SvelteComponentTyped<
ToggleSmallProps,
{
click: WindowEventMap["click"];
mouseover: WindowEventMap["mouseover"];
mouseenter: WindowEventMap["mouseenter"];
mouseleave: WindowEventMap["mouseleave"];
change: WindowEventMap["change"];
keyup: WindowEventMap["keyup"];
focus: WindowEventMap["focus"];
blur: WindowEventMap["blur"];
},
{}
> {}

View file

@ -1,32 +0,0 @@
/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
export interface ToggleSmallSkeletonProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
/**
* Specify the label text
* @default ""
*/
labelText?: string;
/**
* Set an id for the input element
* @default "ccs-" + Math.random().toString(36)
*/
id?: string;
}
/**
* @deprecated This component is deprecated.
* Use`<ToggleSkeleton size="sm" />` instead.
*/
export default class ToggleSmallSkeleton extends SvelteComponentTyped<
ToggleSmallSkeletonProps,
{
click: WindowEventMap["click"];
mouseover: WindowEventMap["mouseover"];
mouseenter: WindowEventMap["mouseenter"];
mouseleave: WindowEventMap["mouseleave"];
},
{}
> {}

View file

@ -1,24 +0,0 @@
/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
export interface HeaderActionSearchProps {
/**
* Set to `true` to focus the search
* @default false
*/
searchIsActive?: boolean;
}
/**
* @deprecated
* This component is deprecated. Use `HeaderSearch` instead.
*/
export default class HeaderActionSearch extends SvelteComponentTyped<
HeaderActionSearchProps,
{
inputSearch: CustomEvent<{ action: "search"; textInput: string }>;
focusInputSearch: CustomEvent<any>;
focusOutInputSearch: CustomEvent<any>;
},
{}
> {}

View file

@ -2,13 +2,7 @@
import { SvelteComponentTyped } from "svelte";
export interface HeaderNavProps
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["nav"]> {
/**
* Specify the ARIA label for the nav
* @default undefined
*/
ariaLabel?: string;
}
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["nav"]> {}
export default class HeaderNav extends SvelteComponentTyped<
HeaderNavProps,

6
types/index.d.ts vendored
View file

@ -60,8 +60,6 @@ export { default as FormLabel } from "./FormLabel/FormLabel.svelte";
export { default as Grid } from "./Grid/Grid.svelte";
export { default as Row } from "./Grid/Row.svelte";
export { default as Column } from "./Grid/Column.svelte";
export { default as Icon } from "./Icon/Icon.svelte";
export { default as IconSkeleton } from "./Icon/IconSkeleton.svelte";
export { default as ImageLoader } from "./ImageLoader/ImageLoader.svelte";
export { default as InlineLoading } from "./InlineLoading/InlineLoading.svelte";
export { default as Link } from "./Link/Link.svelte";
@ -82,7 +80,6 @@ export { default as InlineNotification } from "./Notification/InlineNotification
export { default as NotificationActionButton } from "./Notification/NotificationActionButton.svelte";
export { default as NotificationButton } from "./Notification/NotificationButton.svelte";
export { default as NotificationIcon } from "./Notification/NotificationIcon.svelte";
export { default as NotificationTextDetails } from "./Notification/NotificationTextDetails.svelte";
export { default as NumberInput } from "./NumberInput/NumberInput.svelte";
export { default as NumberInputSkeleton } from "./NumberInput/NumberInputSkeleton.svelte";
export { default as OrderedList } from "./OrderedList/OrderedList.svelte";
@ -139,8 +136,6 @@ export { default as TimePicker } from "./TimePicker/TimePicker.svelte";
export { default as TimePickerSelect } from "./TimePicker/TimePickerSelect.svelte";
export { default as Toggle } from "./Toggle/Toggle.svelte";
export { default as ToggleSkeleton } from "./Toggle/ToggleSkeleton.svelte";
export { default as ToggleSmall } from "./ToggleSmall/ToggleSmall.svelte";
export { default as ToggleSmallSkeleton } from "./ToggleSmall/ToggleSmallSkeleton.svelte";
export { default as Tooltip } from "./Tooltip/Tooltip.svelte";
export { default as TooltipFooter } from "./Tooltip/TooltipFooter.svelte";
export { default as TooltipDefinition } from "./TooltipDefinition/TooltipDefinition.svelte";
@ -150,7 +145,6 @@ export { default as Truncate } from "./Truncate/Truncate.svelte";
export { default as Header } from "./UIShell/GlobalHeader/Header.svelte";
export { default as HeaderAction } from "./UIShell/GlobalHeader/HeaderAction.svelte";
export { default as HeaderActionLink } from "./UIShell/GlobalHeader/HeaderActionLink.svelte";
export { default as HeaderActionSearch } from "./UIShell/GlobalHeader/HeaderActionSearch.svelte";
export { default as HeaderNav } from "./UIShell/GlobalHeader/HeaderNav.svelte";
export { default as HeaderNavItem } from "./UIShell/GlobalHeader/HeaderNavItem.svelte";
export { default as HeaderNavMenu } from "./UIShell/GlobalHeader/HeaderNavMenu.svelte";