+{"description":"","displayName":"Day","methods":[{"name":"makeStylesVariables","docblock":null,"modifiers":["get"],"params":[],"returns":{"type":{"name":"signature","type":"object","raw":"{\n isDisabled: boolean\n}","signature":{"properties":[{"key":"isDisabled","value":{"name":"boolean","required":true}}]}}}},{"name":"isDisabled","docblock":null,"modifiers":["get"],"params":[],"returns":null},{"name":"elementType","docblock":null,"modifiers":["get"],"params":[],"returns":null},{"name":"shouldApplyAriaSelected","docblock":null,"modifiers":[],"params":[],"returns":null},{"name":"handleClick","docblock":null,"modifiers":[],"params":[{"name":"event","optional":false,"type":{"name":"MouseEvent","elements":[{"name":"intersection","raw":"ViewProps & Element","elements":[{"name":"ViewProps"},{"name":"Element"}]}],"raw":"MouseEvent<ViewProps & Element>","alias":"MouseEvent"}}],"returns":null},{"name":"handleKeyDown","docblock":null,"modifiers":[],"params":[{"name":"event","optional":false,"type":{"name":"KeyboardEvent","elements":[{"name":"intersection","raw":"ViewProps & Element","elements":[{"name":"ViewProps"},{"name":"Element"}]}],"raw":"KeyboardEvent<ViewProps & Element>","alias":"KeyboardEvent"}}],"returns":null},{"name":"handleElementRef","docblock":null,"modifiers":[],"params":[{"name":"el","optional":false,"type":{"name":"union","raw":"Element | null","elements":[{"name":"Element"},{"name":"null"}]}}],"returns":null}],"props":{"children":{"required":false,"tsType":{"name":"Renderable"},"description":"The rendered representation of the corresponding date."},"date":{"required":true,"tsType":{"name":"string"},"description":"An ISO 8601 formatted string representing the date corresponding to\nthis `<Calendar.Day />`"},"label":{"required":true,"tsType":{"name":"string"},"description":"Accessible label to provide more context for the date to assistive\ntechnologies. This should consist of more than just a numerical date value.\nIt should also include the month and the year. Ex. instead of just `1`,\nprovide `1 August 2019`."},"interaction":{"required":false,"tsType":{"name":"union","raw":"'enabled' | 'disabled'","elements":[{"name":"literal","value":"'enabled'"},{"name":"literal","value":"'disabled'"}]},"description":"Is the `<Calendar.Day />` disabled","defaultValue":{"value":"'enabled'","computed":false}},"isSelected":{"required":false,"tsType":{"name":"boolean"},"description":"Is the `<Calendar.Day />` selected","defaultValue":{"value":"false","computed":false}},"selectedLabel":{"required":false,"tsType":{"name":"string"},"description":"Screen reader label appended to the date label when the day is selected.\nUsed to announce the selected state to assistive technologies."},"isToday":{"required":false,"tsType":{"name":"boolean"},"description":"Is the `<Calendar.Day />` today","defaultValue":{"value":"false","computed":false}},"isOutsideMonth":{"required":false,"tsType":{"name":"boolean"},"description":"Is the `<Calendar.Day />` located outside the current rendered month","defaultValue":{"value":"false","computed":false}},"onClick":{"required":false,"tsType":{"name":"signature","type":"function","raw":"(\n event: MouseEvent<ViewProps & Element>,\n date: { date: string }\n) => void","signature":{"arguments":[{"type":{"name":"MouseEvent","elements":[{"name":"intersection","raw":"ViewProps & Element","elements":[{"name":"ViewProps"},{"name":"Element"}]}],"raw":"MouseEvent<ViewProps & Element>"},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{ date: string }","signature":{"properties":[{"key":"date","value":{"name":"string","required":true}}]}},"name":"date"}],"return":{"name":"void"}}},"description":"Callback fired on click.\n@param {Object} event - the click event\n@param {Object} data - additional data\n@param data.date - the date of the corresponding `<Calendar.Day />`"},"onKeyDown":{"required":false,"tsType":{"name":"signature","type":"function","raw":"(\n event: KeyboardEvent<ViewProps & Element>,\n data: { date: string }\n) => void","signature":{"arguments":[{"type":{"name":"KeyboardEvent","elements":[{"name":"intersection","raw":"ViewProps & Element","elements":[{"name":"ViewProps"},{"name":"Element"}]}],"raw":"KeyboardEvent<ViewProps & Element>"},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{ date: string }","signature":{"properties":[{"key":"date","value":{"name":"string","required":true}}]}},"name":"data"}],"return":{"name":"void"}}},"description":"Callback fired on key down.\n@param {Object} event - the key down event\n@param {Object} data - additional data\n@param data.date - the date of the corresponding `<Calendar.Day />`"},"elementRef":{"required":false,"tsType":{"name":"signature","type":"function","raw":"(element: Element | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"Element | null","elements":[{"name":"Element"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}}},"description":"A ref function for the underlying DOM element."},"as":{"required":false,"tsType":{"name":"AsElementType"},"description":"the element type to render as"}},"parent":"Calendar","id":"Calendar.Day","relativePath":"packages/ui-calendar/src/Calendar/v1/Day/index.tsx","extension":".tsx","srcPath":"packages/ui-calendar/src/Calendar/v1/Day/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-calendar/src/Calendar/v1/Day/index.tsx","packageName":"@instructure/ui-calendar","requirePath":"@instructure/ui-calendar/lib/Calendar/v1/Day/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-calendar/src/Calendar/v1/Day/index.tsx').default","esPath":"@instructure/ui-calendar/es/Calendar/v1/Day/index","themePath":"packages/ui-calendar/src/Calendar/v1/Day/styles.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-calendar/src/Calendar/v1/Day/styles.ts","title":"Calendar.Day","componentVersion":"v1","componentDirName":"Calendar"}
0 commit comments