Skip to content
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

Add TS types for EuiTab/EuiTabs/EuiTabbedContent #1288

Merged
merged 4 commits into from
Nov 6, 2018

Conversation

joshdover
Copy link
Contributor

Summary

Adds type definitions for the EuiTab and similar components.

Checklist

  • This was checked in mobile
  • This was checked in IE11
  • This was checked in dark mode
  • Any props added have proper autodocs
  • Documentation examples were added
  • A changelog entry exists and is marked appropriately
  • This was checked for breaking changes and labeled appropriately
  • Jest tests were updated or added to match the most common scenarios
  • This was checked against keyboard-only and screenreader scenarios
  • This required updates to Framer X components

expand?: boolean;
}

export const EuiTab: SFC<EuiTabProps>;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because EUI forwards extra all props to an underlying element, we annotate this further with HTMLAttributes<HTMLDivElement>, and solely by convention we usually include CommonProps on this line instead of intersecting them together above.

Suggested change
export const EuiTab: SFC<EuiTabProps>;
export const EuiTab: SFC<EuiTabProps & CommonProps & HTMLAttributes<HTMLDivElement>>;

which comes with another bonus: div elements can optionally have children making the explicit children? in EuiTabProps & EuiTabsProps redundant.

}

export const EuiTab: SFC<EuiTabProps>;
export const EuiTabs: SFC<EuiTabsProps>;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra props in EuiTabsProps are similarly passed through to a div

Suggested change
export const EuiTabs: SFC<EuiTabsProps>;
export const EuiTabs: SFC<EuiTabsProps & CommonProps & HTMLAttributes<HTMLDivElement>>;

@joshdover
Copy link
Contributor Author

@chandlerprall Thanks for the tips, updated!

Copy link
Contributor

@chandlerprall chandlerprall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a changelog entry (see https://github.com/elastic/eui/pull/1265/files for example), then it'll be good to go!

Copy link
Contributor

@chandlerprall chandlerprall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @joshdover !

@joshdover joshdover merged commit 06de080 into elastic:master Nov 6, 2018
@joshdover joshdover deleted the tabs-types branch November 6, 2018 17:13
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 this pull request may close these issues.

2 participants