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

v3.0.0 #6

Merged
merged 24 commits into from
Nov 27, 2023
Merged

v3.0.0 #6

merged 24 commits into from
Nov 27, 2023

Conversation

nruffing
Copy link
Owner

[!CAUTION]

  • node v18 is now the minimum supported version. This was previously v14. v18 is the current oldest lts version of node.
  • data-grid-vue now requires a minimum vue version of 3.3.0. It is also recommended to upgrade to at least version 5.0.2 of vite. Vite v5 migration guide
  • The column-selection-popup slot hiddenUpdated prop has been renamed to onHiddenUpdated to be consistent with similar method names.
  • Methods that return a Promise have been renamed to be suffixed with Async to make it clear that they return a Promise.
    • loadPageData -> loadPageDataAsync
    • onPageSizeChanged -> onPageSizeChangedAsync
    • DataService.getPage -> DataService.getPageAsync
    • StorageService.getGridState -> StorageService.getGridStateAsync
    • StorageService.setGridState -> StorageService.setGridStateAsync

[!TIP]

  • New footer slots

    • footer - entire footer
    • footer-page-size-select - footer page size select
    • footer-additional-content - additional content between page size select and total item text
    • footer-total-items - total items text
  • #4 accessibility improvements

    • Add missing aria-label attributes
    • Allow header to be navigated via keyboard
    • Allow sort and reorder actions to be performed via keyboard when header cell has focus
      • Space or enter to cycle through sort options
      • Left and right arrow to reorder
    • Allow header options to be triggered via space or enter
    • Add/remove column menu is focused when it opens and can be navigated via keyboard using the tab key
  • Display loading spinner when data takes more then a second to load page data. Override loader with loader slot.

  • Add additional parameters to the options-header, options-header-filter-options-shown, and options-header-clear-filters slots.

  • ServerSideStorageService now has a generic type constraint to allow any type to be used for the user identifier sent in the request to get and set grid state.

  • ServerSideStorageService now has a grid id parameter that can be sent to the server to allow for support of multiple grids.

  • ServerSideStorageService.getGridState and ServerSideDataService.getPage will now only try to deserialize the response body as JSON if the status code is 200 OK and the response Content-Type header is application/json.

  • Dynamic column header titles

  • Entire header cell is now the click target for a sort.

  • Default color values of CSS variables are now defined in hex.

  • Default accent color slightly altered to match documentation site.

  • Improved default layout styles of custom column filters set using the filter-{fieldName} slot.

  • Documentation site now includes documentation for DataGridVueDotnet.

  • Repo now uses pnpm where the data-grid-vue package is build from the root workspace and the documentation site and dev app are nested workspaces.

  • Now being built with vite v5.

  • Update debounce dependency to new major version v2.0.0 which requires node v18 (current oldest supported version).

  • Update 'dragon-drop-vue' dependency to v0.2.0

  • Documentation site theme update

  • Documentation site is now setup up as a progressive web app.

  • bugfix: DataGridVueOptions.clickOutsideDirectiveName removed.

  • bugfix: DataGridVueOptions.dragonDropVueOptions.dragDirectiveName and dropDirectiveName will always be overridden to dgv-drag and dgv-drop.

closes #4

@nruffing nruffing self-assigned this Nov 27, 2023
@nruffing nruffing merged commit a8e5201 into main Nov 27, 2023
4 checks passed
@nruffing nruffing deleted the v3.0.0 branch November 27, 2023 02:25
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.

[bug] Accessibility Improvements
1 participant