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

Table-Typings #299

Closed
wants to merge 5 commits into from
Closed

Table-Typings #299

wants to merge 5 commits into from

Conversation

ryceg
Copy link
Contributor

@ryceg ryceg commented Sep 28, 2022

Creates a new folder called types and adds a property that enforces consistent titles for headers.

@endigo9740
Copy link
Contributor

Unfortunately @ryceg I don't think I can move forward with this one. As I mentioned on Discord, it's well intended, but poses a number of issues.

  • Doesn't follow convention for where the Type file should be stored (let's keep these localized, in the component directory)
  • It tries to specify all the various Table prop keys we use in the docs, but this would only be useful for us. Not for end users, which kind of diminishes its usefulness. You would be surprised how many end users try to use stuff that's just for us, such as the SVGIcon component, even though it's completely unlisted. Then of course run into trouble!
  • Just kind of drops the import into each route page wherever. Whereas I'm making a consorted effort to group and organize imports to keep this clear for everyone what and where things are coming from, and what they represent. Introducing an opinionated structure in other words. This is something we absolute need to add to the "style guide" section mentioned for the contributor doc updates.
  • It might have some troublesome overlap with this on-going PR, which started first: Document component keyboard shortcuts (a11y) #292
  • It'll definitely have issue with my upcoming Menu changes, since that's being moved from a Component -> Utility

That said, I think what you have here is solid. We're not going to implement this YET, but we can alongside these changes:

But the important part of not what we're changing, but WHEN we're changing this. So it has minimal impact on others.

FYI the PR will remain here on GitHub so I'll link it in the Table refactor ticket as a reminder to reference this and reimplement a version of the types you did. Again the idea is solid! I want to add it. Just not quite yet!

@endigo9740 endigo9740 closed this Sep 28, 2022
@endigo9740 endigo9740 mentioned this pull request Sep 28, 2022
10 tasks
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