gridcn2.0.0
Support and upgrades

Version policy and changelog

Find how gridcn numbers releases, where the changelog lists breaking changes, and how to pin a release.

gridcn ships as source through the shadcn registry, so it has no npm version. A release is a git tag, and CHANGELOG.md lists what each release changed. Read the changelog before you update installed files.

TopicRule
ReleaseA git tag vMAJOR.MINOR.PATCH
Breaking changeAny release can carry one. The changelog marks it Breaking:.
Public APIThe props, hooks, and exports that the docs name, and data-grid-sdk
Pinned release#<ref> on the GitHub registry path
Security fixesVersion 2.x, and 1.x for 90 days after the 2.0.0 tag, see Supported versions

Release tags

A release is a git tag named vMAJOR.MINOR.PATCH, for example v2.0.0. The changelog heading of each release has the same number and the release date. The docs follow the main branch, so a change that the changelog lists above the newest release heading is in no release tag yet. The tags page lists every release.

Any release can carry a change marked Breaking: in the changelog. Read the changelog of every release between your version and the target. Upgrade gridcn shows how to find your version.

Public API

The props, hooks, and exports that the docs name are the public API. The data-grid-sdk module is the API for add-on authors. Write a plugin shows it. Anything else in an installed file is internal and can change in any release.

Installed files are your source. Upgrade gridcn shows how a new install treats the files that you changed.

Changelog

CHANGELOG.md is at the root of the repository. It follows these rules:

  • The ## 2.0.0 section carries the release date. A section named Unreleased above the newest release lists changes that no tag has shipped. An install without a ref already gets them.
  • Each release has a heading with its number and date.
  • An entry that breaks a public prop, hook, export, or behavior carries the Breaking: marker. It names the replacement or describes the new behavior.
  • 2.0 breaking changes lists the breaking entries of release 2.0 by area, with the 1.3 form and the 2.0 form.
  • The ## 2.0.0 section keeps the breaking entries and a short list of highlights. CHANGELOG-2.0.md lists every other entry of release 2.0, grouped by area.

Removed exports

Release 2.0 removes these names from the barrels:

Twelve names leave the data-grid barrel: useDataGridRowCount, useDataGridHasActiveCell, useDataGridIsSearchMatch, useDataGridIsRowSelected, useDataGridIsRowChannelSelected, useDataGridIsRowCellSelected, useDataGridAllRowsSelected, useDataGridHeaderClickBehavior, useDataGridRowMarkers, useDataGridSelectionConfig, deepMergeLabels, and measureTextWidths. A createDataGridSelector hook reads the store values of the hooks. useDataGridSelectionConfig and deepMergeLabels import from data-grid-sdk. measureTextWidths has no public replacement.

The data-grid-pagination barrel drops pageCount, clampPage, pageRange, pageWindow, DEFAULT_PAGE_SIZES, and UseDataGridPaginationServerOptions. The fill barrel drops FillArgs. The pinned rows barrel drops DataGridPinnedRow, DataGridPinnedRowProps, DataGridPinnedRowBand, and DataGridPinnedRowBandProps. The data-grid-lazy item is gone with its barrel. The toolbar, io, and keybindings barrels drop operatorLabel, operatorsForColumnType, operatorHasValue, buildXlsx, BuildXlsxOptions, downloadBlob, buildExportHeaders, quoteCsvField, IMPORT_PREVIEW_ROW_COUNT, DataGridKeybindingsShortcut, DataGridKeybindingsShortcutProps, KEYBINDING_CATEGORIES, ACTION_CATEGORY, categoryForAction, categoryLabel, KeybindingCategory, and labelForAction.

Pin a release

The hosted @gridcn registry serves the source of the most recent deployment of the main branch. To pin a release, add #<ref> to the GitHub registry path. The ref is a tag, a branch, or a full 40-character commit SHA. Without a ref, the CLI uses the default branch:

pnpm dlx shadcn add DammersCode/gridcn/data-grid#v2.0.0

The ref applies to the item you name. The CLI fetches every registry dependency of that item without the ref, from the default branch. Most add-ons depend on the core item, data-grid. These add-ons also depend on another gridcn item:

Add-onAlso depends on
data-grid-server, data-grid-url-statedata-grid-pagination
data-grid-toolbar, data-grid-find-replace, data-grid-lookupuse-debounce
data-grid-iodropzone

To pin the whole install, install each dependency with the same ref first. Install data-grid before the others. Then install the add-on. If the CLI asks to overwrite a dependency file, answer no.

To resolve a tag, a branch, or the default branch, the CLI runs git ls-remote. It then reads the files from raw.githubusercontent.com. If git ls-remote fails, the CLI resolves the ref through the GitHub API. It uses the GH_TOKEN or GITHUB_TOKEN variable, or the gh CLI when neither is set. A full commit SHA skips the lookup. A @gridcn install, core or add-on, fetches every gridcn dependency from the hosted registry and needs neither git nor GitHub access. Only a GitHub-path install (DammersCode/gridcn/<item>) runs git ls-remote.

Support

Report bugs and feature requests in the issue tracker. Ask questions in the Q&A discussions. To report a vulnerability, follow the Security policy.

On this page