@mskcc/carbon-react
Version:
Carbon react components for the MSKCC DSM
30 lines (29 loc) • 1.01 kB
TypeScript
/**
* MSKCC DSM 2021, 2023
*/
import { ComponentProps } from 'react';
import PropTypes from 'prop-types';
type SkipToContentProps = Omit<ComponentProps<'a'>, 'children'> & {
children?: string | undefined;
};
declare function SkipToContent({ children, className: customClassName, href, tabIndex, ...rest }: SkipToContentProps): JSX.Element;
declare namespace SkipToContent {
var propTypes: {
/**
* A ReactNode to display in the SkipToContent `a` tag.
* `'Skip to main content'` by default.
*/
children: PropTypes.Requireable<string>;
className: PropTypes.Requireable<string>;
/**
* Provide the `href` to the id of the element on your package that is the
* main content. `#main-content` by default.
*/
href: PropTypes.Requireable<string>;
/**
* Optionally override the default tabindex of 0
*/
tabIndex: PropTypes.Requireable<string>;
};
}
export default SkipToContent;