Skip to content

Docs: @propType and @hide annotations do not function #2332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dlabrecq opened this issue Dec 28, 2020 · 2 comments · Fixed by #2334
Closed

Docs: @propType and @hide annotations do not function #2332

dlabrecq opened this issue Dec 28, 2020 · 2 comments · Fixed by #2334

Comments

@dlabrecq
Copy link
Member

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.

Screen Shot 2020-12-28 at 12 40 14 PM

@dlabrecq
Copy link
Member Author

FYI @redallen

@dlabrecq dlabrecq changed the title Docs: @propType and @hide do not appear to function Docs: @propType and @hide annotation do not function Dec 28, 2020
@dlabrecq dlabrecq changed the title Docs: @propType and @hide annotation do not function Docs: @propType and @hide annotations do not function Dec 28, 2020
@redallen redallen transferred this issue from patternfly/patternfly-react Jan 4, 2021
@redallen
Copy link
Collaborator

redallen commented Jan 4, 2021

The file responsible for implementing these did have @propType removed when upgrading the site. We can add that back and see why @hide isn't working like you expect.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants