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

Datagrid: Improve documentation #2917

Closed
elycheea opened this issue Apr 24, 2023 · 1 comment
Closed

Datagrid: Improve documentation #2917

elycheea opened this issue Apr 24, 2023 · 1 comment
Assignees
Labels

Comments

@elycheea
Copy link
Contributor

elycheea commented Apr 24, 2023

What will this achieve?

Ensure hooks are documented and that feature flag approach is clear

How will success be measured?

Hook Doc status
useExpandableRow ✅ Yes
useActionsColumn ✅ Yes
useColumnCenterAlign ✅ Yes
useColumnOrder ✅ Yes
useColumnRightAlign ✅ Yes
useCustomizeColumns ✅ Yes
useDatagrid ✅ Yes
useDefaultStringRenderer ✅ Internal
useDisableSelectRows ✅ Yes
useFiltering ✅ Yes
useFlexResize ✅ Internal
useFloatingScroll ✅ Internal
useInfiniteScroll ✅ Yes
useInlineEdit ✅ Yes
useNestedRowExpander ✅ Internal
useNestedRows ✅ Yes
useOnRowClick ✅ Yes
useParentDimensions ✅ Internal
useResizeTable ✅ Internal
useRowExpander ✅ Internal
useRowIsMouseOver ✅ Yes
useRowRenderer ✅ Internal
useRowSize ✅ Internal
useSelectAllWithToggle ✅ Yes
useSelectRows ✅ Yes
useSkeletonRows ✅ Internal
useSortableColumns ✅ Yes
useStickyColumn ✅ Yes
getAutoSizedColumnWidth ✅ Yes

Feature flags

Current list of hooks that will be under feature flag until after base component is released:

useFiltering
useExpandedRow
CustomizeColumns - Show/hide
CustomizeColumns - Reorder
useNestedRows
useInlineEdit/useEditableCell
useActionsColumn

useRowSize is listed in Mural as an additional "plugin" on top of base component, but the useRowSize hook is actually part of the base component. See here.

Additional information

  • Designs
  • Existing code
  • etc
@elycheea
Copy link
Contributor Author

@matthewgallo also added more content on DatagridActions. Closing this for now since it looks pretty comprehensive.

@github-project-automation github-project-automation bot moved this from In progress to Accessibility review ♿ in Carbon for IBM Products Jun 12, 2023
@elycheea elycheea moved this from Accessibility review ♿ to Done 🚀 in Carbon for IBM Products Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

No branches or pull requests

3 participants