External props interfaces not displayed

[MoctezumaDev]

One issue that we are facing is that if the props interface is not defined in the same file *.tsx where the reactjs component was defined then styleguidist will not display the possible properties.

I created an Example Project to show our issues.

[kidkuro]

Further to this, inherited props from extended interfaces are not displayed.

// Field.tsx
export interface IFieldProps {
  error?: string; // not documented on SelectField
}

// SelectField.tsx
import { IFieldProps } from './Field';
export interface ISelectFieldProps extends IFieldProps {
  options: ISelectOption[]; // documented on SelectField
}
export const SelectField = (props: ISelectFieldProps) => (
...

In this example, we would want both error and options to be documented for SelectField

However, in reality ISelectFieldProps would also extend React.HTMLProps<HTMLSelectElement>, but we would not want to document all of the select element props.

[pvasek]

This should be fixed in v0.0.12 release. Can you confirm that?

[paibamboo]

@pvasek On contrary we have an interface for base button props that extends from React.HTMLProps<HTMLButtonElement>

  interface IProps extends React.HTMLProps<HTMLButtonElement> {
    ...
  }

So we don't want to list them in the document. Since styleguidist provides a function to ignore prop one by one, It would be nice for react-docgen-typescript to have an ability to ignore extended props.

  /*
  * @ignore_extended
  */
  interface IProps extends React.HTMLProps<HTMLButtonElement> {
    ...
  }

[olegsmetanin]

@paibamboo You can use markdown tables in comments jsdoc/jsdoc#1064