@dotconnor/grommet
Version:
focus on the essential experience
26 lines • 1.31 kB
JavaScript
import { describe, PropTypes } from 'react-desc';
import { getAvailableAtBadge } from '../../utils/mixins';
export var doc = function doc(Tip) {
var DocumentedTip = describe(Tip).availableAt(getAvailableAtBadge('Tip', 'Controls')).description("Tooltip or a hint when hovering over an element. The tooltip will render \n when hovering on top of the Tip's child node or string.").usage("import { Tip } from 'grommet';\n<Tip />");
DocumentedTip.propTypes = {
content: PropTypes.node.description("The tooltip content inside the drop."),
dropProps: PropTypes.object.description('Any valid Drop prop to style the Tip drop container.').defaultValue({
plain: true,
trapFocus: false
}),
plain: PropTypes.bool.description("Whether content should have default styling.").defaultValue(undefined)
};
return DocumentedTip;
};
export var themeDoc = {
'tip.content': {
description: 'Any valid Box property for the Tip container.',
type: 'object',
defaultValue: "{ background: 'background-contrast', elevation: 'small', \n margin: 'xsmall', pad: { vertical: 'xsmall', horizontal: 'small' }, \n round: 'small'}"
},
'tip.drop': {
description: 'Any valid Drop property for the Tooltip.',
type: 'object',
defaultValue: "{align: { top: 'bottom' }}"
}
};