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.

Sign up for GitHub

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

Mark deprecated components as deprecated using JSDoc/TypeScript #3240

Merged
merged 1 commit into from
Oct 7, 2024
Merged

Mark deprecated components as deprecated using JSDoc/TypeScript #3240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ export const
export const
Carousel: any, CarouselItem: any, CAROUSEL_NEXT_LABEL_TEXT: any, CAROUSEL_PREV_LABEL_TEXT: any;
// from './Carousel';
/** @deprecated Replaced by `Form.Checkbox`. */
export const CheckBox: any; // from './CheckBox';
/** @deprecated Replaced by `Form.Checkbox` and `Form.CheckboxSet`. */
export const CheckBoxGroup: any; // from './CheckBoxGroup';
export const CloseButton: any; // from './CloseButton';
export const Layout: any, Col: any, Row: any; // from './Layout';
Expand All @@ -53,6 +55,7 @@ export const
SplitButton: any;
// from './Dropdown';
export const Fade: any; // from './Fade';
/** @deprecated */
export const Fieldset: any; // from './Fieldset';
export const
Form: any,
Expand All @@ -77,17 +80,23 @@ export const
InputGroup: any;
// from './Form';
export const IconButtonToggle: any; // from './IconButtonToggle';
/** @deprecated Replaced by `Form.Control`. */
export const Input: any; // from './Input';
/** @deprecated Replaced by `Form.Control`. */
export const InputSelect: any; // from './InputSelect';
/** @deprecated Replaced by `Form.Control`. */
export const InputText: any; // from './InputText';
export const Image: any, Figure; // from './Image';
/** @deprecated */
export const ListBox: any; // from './ListBox';
/** @deprecated */
export const ListBoxOption: any; // from './ListBoxOption';
export const MailtoLink: any, MAIL_TO_LINK_EXTERNAL_LINK_ALTERNATIVE_TEXT: string, MAIL_TO_LINK_EXTERNAL_LINK_TITLE: string; // from './MailtoLink';
export const Media: any; // from './Media';
export const Menu: any; // from './Menu';
export const MenuItem: any; // from './Menu/MenuItem';
export const SelectMenu: any, SELECT_MENU_DEFAULT_MESSAGE: string; // from './Menu/SelectMenu';
/** @deprecated Use `ModalDialog` instead. */
export const Modal: any; // from './Modal';
export const ModalCloseButton: any; // from './Modal/ModalCloseButton';
export const FullscreenModal: any, FULLSCREEN_MODAL_CLOSE_LABEL: string; // from './Modal/FullscreenModal';
Expand Down Expand Up @@ -122,6 +131,7 @@ export const
export const Popover: any, PopoverTitle: any, PopoverContent: any; // from './Popover';
export const ProgressBar: any; // from './ProgressBar';
export const ProductTour: any; // from './ProductTour';
/** @deprecated Replaced by `Form.Radio` and `Form.RadioSet`. */
export const RadioButtonGroup: any, RadioButton: any; // from './RadioButtonGroup';
export const ResponsiveEmbed: any; // from './ResponsiveEmbed';
export const
Expand All @@ -135,7 +145,9 @@ export const Sheet: any; // from './Sheet';
export const Spinner: any; // from './Spinner';
export const Stepper: any; // from './Stepper';
export const StatefulButton: any; // from './StatefulButton';
/** @deprecated Replaced by `Alert`. */
export const StatusAlert: any; // from './StatusAlert';
/** @deprecated Replaced by `DataTable`. */
export const Table: any; // from './Table';
export const
Tabs: any,
Expand All @@ -144,8 +156,10 @@ export const
TabContent: any,
TabPane: any;
// from './Tabs';
/** @deprecated Replaced by `Form.Control`. */
export const TextArea: any; // from './TextArea';
export const Toast: any, TOAST_CLOSE_LABEL_TEXT: string, TOAST_DELAY: number; // from './Toast';
/** @deprecated Replaced by `Form.Group`. */
export const ValidationFormGroup: any; // from './ValidationFormGroup';
export const TransitionReplace: any; // from './TransitionReplace';
export const ValidationMessage: any; // from './ValidationMessage';
Expand Down
16 changes: 15 additions & 1 deletion src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ export { default as Bubble } from './Bubble';
export { default as Button, ButtonGroup, ButtonToolbar } from './Button';
export { default as Chip, CHIP_PGN_CLASS } from './Chip';
export { default as ChipCarousel } from './ChipCarousel';
export { default as Container } from './Container';
export { default as Hyperlink, HYPER_LINK_EXTERNAL_LINK_ALT_TEXT, HYPER_LINK_EXTERNAL_LINK_TITLE } from './Hyperlink';
export { default as Icon } from './Icon';
export { default as IconButton, IconButtonWithTooltip } from './IconButton';
Expand Down Expand Up @@ -38,10 +39,11 @@ export {
export {
default as Carousel, CarouselItem, CAROUSEL_NEXT_LABEL_TEXT, CAROUSEL_PREV_LABEL_TEXT,
} from './Carousel';
/** @deprecated Replaced by `Form.Checkbox`. */
export { default as CheckBox } from './CheckBox';
/** @deprecated Replaced by `Form.Checkbox` and `Form.CheckboxSet`. */
export { default as CheckBoxGroup } from './CheckBoxGroup';
export { default as CloseButton } from './CloseButton';
export { default as Container } from './Container';
export { default as Layout, Col, Row } from './Layout';
export { default as Collapse } from './Collapse';
export { default as Collapsible } from './Collapsible';
Expand All @@ -53,6 +55,7 @@ export {
SplitButton,
} from './Dropdown';
export { default as Fade } from './Fade';
/** @deprecated */
export { default as Fieldset } from './Fieldset';
export {
default as Form,
Expand All @@ -77,17 +80,23 @@ export {
InputGroup,
} from './Form';
export { default as IconButtonToggle } from './IconButtonToggle';
/** @deprecated Replaced by `Form.Control`. */
export { default as Input } from './Input';
/** @deprecated Replaced by `Form.Control`. */
export { default as InputSelect } from './InputSelect';
/** @deprecated Replaced by `Form.Control`. */
export { default as InputText } from './InputText';
export { default as Image, Figure } from './Image';
/** @deprecated */
export { default as ListBox } from './ListBox';
/** @deprecated */
export { default as ListBoxOption } from './ListBoxOption';
export { default as MailtoLink, MAIL_TO_LINK_EXTERNAL_LINK_ALTERNATIVE_TEXT, MAIL_TO_LINK_EXTERNAL_LINK_TITLE } from './MailtoLink';
export { default as Media } from './Media';
export { default as Menu } from './Menu';
export { default as MenuItem } from './Menu/MenuItem';
export { default as SelectMenu, SELECT_MENU_DEFAULT_MESSAGE } from './Menu/SelectMenu';
/** @deprecated Use `ModalDialog` instead. */
export { default as Modal } from './Modal';
export { default as ModalCloseButton } from './Modal/ModalCloseButton';
export { default as FullscreenModal, FULLSCREEN_MODAL_CLOSE_LABEL } from './Modal/FullscreenModal';
Expand Down Expand Up @@ -122,6 +131,7 @@ export {
export { default as Popover, PopoverTitle, PopoverContent } from './Popover';
export { default as ProgressBar } from './ProgressBar';
export { default as ProductTour } from './ProductTour';
/** @deprecated Replaced by `Form.Radio` and `Form.RadioSet`. */
export { default as RadioButtonGroup, RadioButton } from './RadioButtonGroup';
export { default as ResponsiveEmbed } from './ResponsiveEmbed';
export {
Expand All @@ -135,7 +145,9 @@ export { default as Sheet } from './Sheet';
export { default as Spinner } from './Spinner';
export { default as Stepper } from './Stepper';
export { default as StatefulButton } from './StatefulButton';
/** @deprecated Replaced by `Alert`. */
export { default as StatusAlert } from './StatusAlert';
/** @deprecated Replaced by `DataTable`. */
export { default as Table } from './Table';
export {
default as Tabs,
Expand All @@ -144,8 +156,10 @@ export {
TabContent,
TabPane,
} from './Tabs';
/** @deprecated Replaced by `Form.Control`. */
export { default as TextArea } from './TextArea';
export { default as Toast, TOAST_CLOSE_LABEL_TEXT, TOAST_DELAY } from './Toast';
/** @deprecated Replaced by `Form.Group`. */
export { default as ValidationFormGroup } from './ValidationFormGroup';
export { default as TransitionReplace } from './TransitionReplace';
export { default as ValidationMessage } from './ValidationMessage';
Expand Down
Loading