@wordpress/components
Version:
UI components for WordPress.
67 lines • 2.61 kB
TypeScript
export default BaseControl;
export type Props = {
/**
* The id of the element to which labels and help text are being generated.
* That element should be passed as a child.
*/
id: string;
/**
* If this property is added, a help text will be
* generated using help property as the content.
*/
help: import('react').ReactNode;
/**
* If this property is added, a label will be generated
* using label property as the content.
*/
label: import('react').ReactNode;
/**
* If true, the label will only be visible to screen readers.
*/
hideLabelFromVision?: boolean | undefined;
/**
* The class that will be added with "components-base-control" to the
* classes of the wrapper div. If no className is passed only
* components-base-control is used.
*/
className?: string | undefined;
/**
* The content to be displayed within
* the BaseControl.
*/
children?: import('react').ReactNode;
};
export type VisualLabelProps = {
/**
* Class name
*/
className?: string | undefined;
/**
* Children
*/
children?: import('react').ReactNode;
};
/**
* @typedef Props
* @property {string} id The id of the element to which labels and help text are being generated.
* That element should be passed as a child.
* @property {import('react').ReactNode} help If this property is added, a help text will be
* generated using help property as the content.
* @property {import('react').ReactNode} label If this property is added, a label will be generated
* using label property as the content.
* @property {boolean} [hideLabelFromVision] If true, the label will only be visible to screen readers.
* @property {string} [className] The class that will be added with "components-base-control" to the
* classes of the wrapper div. If no className is passed only
* components-base-control is used.
* @property {import('react').ReactNode} [children] The content to be displayed within
* the BaseControl.
*/
/**
* @param {Props} props
* @return {JSX.Element} Element
*/
declare function BaseControl({ id, label, hideLabelFromVision, help, className, children, }: Props): JSX.Element;
declare namespace BaseControl {
function VisualLabel({ className, children }: VisualLabelProps): JSX.Element;
}
//# sourceMappingURL=index.d.ts.map