Improve DataGrid doc - Githubissues

jmix-framework / jmix-docs

Documentation for Jmix framework

https://www.jmix.io

Creative Commons Attribution 4.0 International

17 stars 43 forks source link

Improve DataGrid doc #716

Open KremnevDmitry opened 4 months ago

KremnevDmitry commented 4 months ago

Description

Existing page: https://docs.jmix.io/jmix/flow-ui/vc/components/dataGrid.html

General:
- Update examples for renderers, using renderers with @Supply annotation (UI Samples link), using predefined XML renderers (localDateRenderer, localDateTimeRenderer etc.) (https://github.com/jmix-framework/jmix-docs/issues/600)
- No info for other column handlers
- Document aggregation
- Document headerFilter
- Document sort by multiple columns
- Document header and footer API - UI Samples link - CUBA Doc
- ItemsDetails UI Samples link
Add attributes:
- columns
  - Add resizable, sortable attributes for columns element. Describe the priority of these attributes. columns - according to the default for all. The attribute value in the column takes precedence.
- column
  - filterable
- dataGrid
  - aggregatable, aggregationPosition
  - css
  - focusShortcut
  - multiSort, multiSortOnShiftClickOnly, multiSortPriority (+ link to the Vaadin's doc)
Add handlers:
- enterPressHandler
- tooltipGenerator

sukhova commented 3 months ago

1) Document double click actions 2) URL Parameters for Filter in Column Headers 3) Column Visibility Control