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

API type experiment #1960

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

API type experiment #1960

wants to merge 2 commits into from

Conversation

dej611
Copy link
Contributor

@dej611 dej611 commented Feb 9, 2023

Summary

This PR makes types exposed at the API level unpacked and a bit easier to use within the development process.

Here's the previous type contract in a typical API type:
Screenshot 2023-02-09 at 14 08 43

Here's the new one:
Screenshot 2023-02-09 at 13 58 22

Details

Issues

Checklist

  • The proper chart type label has been added (e.g. :xy, :partition)
  • The proper feature labels have been added (e.g. :interactions, :axis)
  • The :theme label has been added and the @elastic/eui-design team has been pinged when there are Theme API changes
  • All related issues have been linked (i.e. closes #123, fixes #123)
  • New public API exports have been added to packages/charts/src/index.ts
  • Unit tests have been added or updated to match the most common scenarios
  • The proper documentation and/or storybook story has been added or updated
  • The code has been checked for cross-browser compatibility (Chrome, Firefox, Safari, Edge)
  • Visual changes have been tested with all available themes including dark, light, eui-dark & eui-light

@elastic-datavis
Copy link
Contributor

Deployments - 8c3769e

  • Storybook (link)
  • e2e server (link)
  • Playwright report (link)

@nickofthyme
Copy link
Collaborator

This is interesting, @monfera was talking about doing something like this to flatten our API types.

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