You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
62 lines
2.3 KiB
62 lines
2.3 KiB
import PropTypes from 'prop-types';
|
|
import { TabsProps } from '@restart/ui/Tabs';
|
|
import { TransitionType } from './helpers';
|
|
export interface TabContainerProps extends Omit<TabsProps, 'transition'> {
|
|
transition?: TransitionType;
|
|
}
|
|
declare const TabContainer: {
|
|
({ transition, ...props }: TabContainerProps): JSX.Element;
|
|
propTypes: {
|
|
/**
|
|
* HTML id attribute, required if no `generateChildId` prop
|
|
* is specified.
|
|
*
|
|
* @type {string}
|
|
*/
|
|
id: PropTypes.Requireable<string>;
|
|
/**
|
|
* Sets a default animation strategy for all children `<TabPane>`s.
|
|
* Defaults to `<Fade>` animation; else, use `false` to disable, or a
|
|
* custom react-transition-group `<Transition/>` component.
|
|
*
|
|
* @type {{Transition | false}}
|
|
* @default {Fade}
|
|
*/
|
|
transition: PropTypes.Requireable<boolean | PropTypes.ReactComponentLike>;
|
|
/**
|
|
* Wait until the first "enter" transition to mount tabs (add them to the DOM)
|
|
*/
|
|
mountOnEnter: PropTypes.Requireable<boolean>;
|
|
/**
|
|
* Unmount tabs (remove it from the DOM) when they are no longer visible
|
|
*/
|
|
unmountOnExit: PropTypes.Requireable<boolean>;
|
|
/**
|
|
* A function that takes an `eventKey` and `type` and returns a unique id for
|
|
* child tab `<NavItem>`s and `<TabPane>`s. The function _must_ be a pure
|
|
* function, meaning it should always return the _same_ id for the same set
|
|
* of inputs. The default value requires that an `id` to be set for the
|
|
* `<TabContainer>`.
|
|
*
|
|
* The `type` argument will either be `"tab"` or `"pane"`.
|
|
*
|
|
* @defaultValue (eventKey, type) => `${props.id}-${type}-${eventKey}`
|
|
*/
|
|
generateChildId: PropTypes.Requireable<(...args: any[]) => any>;
|
|
/**
|
|
* A callback fired when a tab is selected.
|
|
*
|
|
* @controllable activeKey
|
|
*/
|
|
onSelect: PropTypes.Requireable<(...args: any[]) => any>;
|
|
/**
|
|
* The `eventKey` of the currently active tab.
|
|
*
|
|
* @controllable onSelect
|
|
*/
|
|
activeKey: PropTypes.Requireable<string | number>;
|
|
};
|
|
displayName: string;
|
|
};
|
|
export default TabContainer;
|