[Docs] Convert all Elastic Charts docs pages to Typescript #7277
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
- convert `PropTypes` to TS types - Inline events to avoid having to type them explicitly
cee-chen
added
documentation
- convert to new API
- some where moved to theme settings instead, others just shouldn't have been there at all in the first place?
- mixed logic is a bit of a headache try to simplify it via a conditional generic
- moving onChange callback to inline removes the need for typing the params explicitly
- which removes the need to type the params explicitly
- remove unused text/title props - make `description` correctly conditional, and add more spacing to the affected card to make up for it
- including obj iteration microperf improvements
- charts lib appears to work now with react 18
cee-chen
force-pushed
the
charts-docs-types
branch
from
5bd19b5 to
c99b5e3
Compare
|
@nickofthyme Hey hey! Would appreciate your help with the following:
The rest of the commits are pretty straightforward type updates and I'm fairly confident in them, but the above ones are props/APIs owned by your team that I kinda guesstimated by either looking through your changelog or repo. In particular I'm not confident in |
|
Oh no 😞, not too surprised. Yes, happy to take a look! |
|
Preview staging links for this PR:
|
💚 Build Succeeded
History
|
|
Huzzah!! Thank you for the fixes Nick, you rock! |
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
Turns out there's a whole lot of out of date APIs that weren't getting caught in our automated Elastic Charts updates, because the files were in JS 😬 This should help our docs keep more up to date with charts APIs.
QA
General checklist
N/A, docs only