Repository navigation
Docs: @propType and @hide annotations do not function #2332
Description
When I add @deprecated to a component prop, I can see it output in the example docs. However, I don't see a similar result with the @propType and @hide functionality added via #1671.
I'm expecting to see a different property type, for Chart props below, which is shown by the area chart example.
export interface ChartProps extends VictoryChartProps {
/**
* The animate prop specifies props for VictoryAnimation to use.
* The animate prop should also be used to specify enter and exit
* transition configurations with the `onExit` and `onEnter` namespaces respectively.
*
* @example {duration: 500, onExit: () => {}, onEnter: {duration: 500, before: () => ({y: 0})})}
*
* @propType boolean || object <------------
*/
animate?: boolean | AnimatePropTypeInterface;
Is there a trick to get this working locally? I can see @deprecated when I rebuild the docs, but @propType and @hide do not appear to do anything.
Activity
dlabrecq commentedon Dec 28, 2020
FYI @redallen
[-]Docs: @propType and @hide do not appear to function[/-][+]Docs: @propType and @hide annotation do not function[/+][-]Docs: @propType and @hide annotation do not function[/-][+]Docs: @propType and @hide annotations do not function[/+]redallen commentedon Jan 4, 2021
The file responsible for implementing these did have
@propTyperemoved when upgrading the site. We can add that back and see why@hideisn't working like you expect.