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

Tweaks to DataTable generics #1968

Conversation

brunnerh
Copy link
Contributor

@brunnerh brunnerh commented May 4, 2024

Adjustments for #1954.

  • Make key in cell slot prop less strict to prevent type errors in markup.
    Type errors are hard to deal with in Svelte 3/4, this could be reverted again in Svelte 5.
  • No longer exclude id from possible keys.
  • Resolve property path names up to one level deep for header keys.
    Limited to one level for now as combinatorial explosion can make type resolution quite heavy.
    For deeper levels a custom helper function could be used or, as with synthetic keys, as any can be used to ignore the type error.

I added some line breaks for readability in the source, these seem to be added to the COMPONENT_API.json but the docs are not visibly affected.

The types in DataTableTypes.d.ts are currently not directly accessible via the docs. (Also, the name and location of that file is debatable. The types are not really specific to this component and could potentially become useful elsewhere.)

- Make key in `cell` slot prop less strict to prevent type errors in markup.
- Resolve property path names up to one level deep for header keys.
@metonym metonym merged commit 227b9dc into carbon-design-system:sveld-generics May 4, 2024
1 check passed
@brunnerh brunnerh deleted the datatable-generics-tweaks branch May 4, 2024 21:29
@metonym
Copy link
Collaborator

metonym commented May 4, 2024

The nested keys are great.

Screenshot 2024-05-04 at 2 37 16 PM

metonym pushed a commit that referenced this pull request Aug 23, 2024
Adjust DataTable types.
- Make key in `cell` slot prop less strict to prevent type errors in markup.
- Resolve property path names up to one level deep for header keys.
metonym pushed a commit that referenced this pull request Aug 23, 2024
Adjust DataTable types.
- Make key in `cell` slot prop less strict to prevent type errors in markup.
- Resolve property path names up to one level deep for header keys.
metonym pushed a commit that referenced this pull request Sep 13, 2024
Adjust DataTable types.
- Make key in `cell` slot prop less strict to prevent type errors in markup.
- Resolve property path names up to one level deep for header keys.
metonym pushed a commit that referenced this pull request Nov 10, 2024
Adjust DataTable types.
- Make key in `cell` slot prop less strict to prevent type errors in markup.
- Resolve property path names up to one level deep for header keys.
metonym pushed a commit that referenced this pull request Nov 10, 2024
Adjust DataTable types.
- Make key in `cell` slot prop less strict to prevent type errors in markup.
- Resolve property path names up to one level deep for header keys.
metonym pushed a commit that referenced this pull request Nov 12, 2024
Adjust DataTable types.
- Make key in `cell` slot prop less strict to prevent type errors in markup.
- Resolve property path names up to one level deep for header keys.
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