Add TS types for EuiTab/EuiTabs/EuiTabbedContent #1288
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chandlerprall
suggested changes
Nov 5, 2018
src/components/tabs/index.d.ts
Outdated
| expand?: boolean; | ||
| } | ||
|
|
||
| export const EuiTab: SFC<EuiTabProps>; |
There was a problem hiding this comment.
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.
src/components/tabs/index.d.ts
Outdated
| } | ||
|
|
||
| export const EuiTab: SFC<EuiTabProps>; | ||
| export const EuiTabs: SFC<EuiTabsProps>; |
There was a problem hiding this comment.
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>>; |
|
@chandlerprall Thanks for the tips, updated! |
chandlerprall
suggested changes
Nov 6, 2018
There was a problem hiding this comment.
Needs a changelog entry (see https://github.com/elastic/eui/pull/1265/files for example), then it'll be good to go!
chandlerprall
approved these changes
Nov 6, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds type definitions for the EuiTab and similar components.
Checklist