Skip to content

Commit

Permalink
Docs: Add 12.1.0 docs (#9599)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jakub Wiśniewski committed Jun 28, 2022
1 parent dfe871d commit 127f82c
Show file tree
Hide file tree
Showing 35 changed files with 170 additions and 138 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/02-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "Handsontable Documentation"
about: Issues regarding Handsontable documentation.
title: "Docs: "
labels: "Docs: Content"
assignees: "kirszenbaum"
assignees: ""
---

### Description
Expand Down
41 changes: 22 additions & 19 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [12.1.0] - 2022-06-28

### Fixed
- Fixed the dropdown/autocomplete editor's list positioning when the `preventOverflow` option was used. [#3828](https://github.com/handsontable/handsontable/issues/3828)
- Fixed bug related to desynchronization of bottom layers position when table's height is set by settings [#4454](https://github.com/handsontable/handsontable/issues/4454)
- Fixed a bug related to the comments positioning. [#4785](https://github.com/handsontable/handsontable/issues/4785)
- Fixed comment positioning in a scrollable element. [#6744](https://github.com/handsontable/handsontable/issues/6744)
- Improved the UI experience for row and column moving for cases where there are some hidden rows and/or columns and the scrollbar appears. [#7613](https://github.com/handsontable/handsontable/issues/7613)
- Fixed table DOM element's size update after changing `height`/`width` options. [#8688](https://github.com/handsontable/handsontable/issues/8688)
- Fixed the issue where Handsontable initialized within the `<form>` element could trigger a dropdown menu while pressing the `enter` key on different form's input elements. [#9295](https://github.com/handsontable/handsontable/issues/9295)
- Fixed merge cells toggling bug for table initialized in RTL layout direction mode. [#9362](https://github.com/handsontable/handsontable/issues/9362)
- Fixed an issue where columns wider than the table's viewport width and rows with height greater than the table's viewport height didn't render correctly. [#9473](https://github.com/handsontable/handsontable/issues/9473)
- Fixed a bug where the table can be scrolled outside of the table viewport when it runs in RTL document mode and on mobile devices. [#9475](https://github.com/handsontable/handsontable/issues/9475)
- Fixed columns widths calculation for nested headers when hidden columns are applied. [#9496](https://github.com/handsontable/handsontable/issues/9496)
- Removed inconsistency in the ShortcutManager - both `keydown` and `keyup` events won't be handled by the manager in some cases [#9562](https://github.com/handsontable/handsontable/issues/9562)
- *React:* Removed the deprecation warnings for React 17+. [#8748](https://github.com/handsontable/handsontable/issues/8748)
For more information on this release, see:
- [Release notes](https://handsontable.com/docs/release-notes/#_12-1-0)
- [Blog post](https://handsontable.com/blog/handsontable-12.1.0-data-grid-new-hooks-new-translations-and-rendering-improvements)

### Added
- Added `getNearestNotHiddenIndex()`, a new method that finds a visual index of the nearest not-hidden row or column, and works even with large numbers of hidden rows or columns. The previous method, `getFirstNotHiddenIndex()` still works, but is marked as deprecated. [#9064](https://github.com/handsontable/handsontable/issues/9064)
- Added Czech language [#9343](https://github.com/handsontable/handsontable/issues/9343)
- Added localization support for the Serbian language [#9469](https://github.com/handsontable/handsontable/issues/9469)
- Added smoother row and column moving when some row or columns are hidden. [#7613](https://github.com/handsontable/handsontable/issues/7613)
- Added `getNearestNotHiddenIndex()`, a new method that finds the visual index of the nearest not-hidden row or column and works even with large numbers of hidden rows or columns. The previous method, `getFirstNotHiddenIndex()`, still works, but is marked as deprecated. [#9064](https://github.com/handsontable/handsontable/issues/9064)
- Added a Czech translation. [#9343](https://github.com/handsontable/handsontable/issues/9343)
- Added a Serbian translation. [#9469](https://github.com/handsontable/handsontable/issues/9469)
- Added new hooks: `beforeColumnFreeze`, `afterColumnFreeze`, `beforeColumnUnfreeze`, and `afterColumnUnfreeze`. [#9248](https://github.com/handsontable/handsontable/issues/9248)

### Changed
- Updated the Pikaday dependency to 1.8.2. [#9410](https://github.com/handsontable/handsontable/issues/9410)
- Replaced the HTML entities to its canonical form in the LICENSE.txt files. [#9487](https://github.com/handsontable/handsontable/issues/9487)
- Replaced HTML entities appearing in Handsontable's license texts with canonical counterparts. [#9487](https://github.com/handsontable/handsontable/issues/9487)
- Updated the Pikaday optional dependency to 1.8.2, to let Handsontable work with Parcel 2 without errors. [#9410](https://github.com/handsontable/handsontable/issues/9410)
- *React:* Changed the wrapper's lifecycle methods, to let Handsontable work with React 17+ without warnings. [#8748](https://github.com/handsontable/handsontable/issues/8748)
- *Angular:* Moved the `@angular/core` dependency to peer dependencies. [#9574](https://github.com/handsontable/handsontable/issues/9574)

### Fixed
- Fixed an issue where dropdown and autocomplete cell editors rendered incorrectly if the `preventOverflow` option was set to `'horizontal'`. [#3828](https://github.com/handsontable/handsontable/issues/3828)
- Fixed an issue where frozen rows were getting duplicated. [#4454](https://github.com/handsontable/handsontable/issues/4454)
- Fixed an issue where comments rendered outside the viewport. [#4785](https://github.com/handsontable/handsontable/issues/4785)
- Fixed an issue where comments got positioned incorrectly when Handsontable ran within a scrollable element. [#6744](https://github.com/handsontable/handsontable/issues/6744)
- Fixed an issue that occurred when Handsontable ran within an HTML `<form>`: pressing <kbd>Enter</kbd> inside another form's `<input>` could open Handsontable's dropdown menu. [#9295](https://github.com/handsontable/handsontable/issues/9295)
- Fixed an issue where it was impossible to unmerge cells in the RTL layout direction. [#9362](https://github.com/handsontable/handsontable/issues/9362)
- Fixed an issue where columns wider than the viewport's width and rows higher than the viewport's height didn't render correctly. [#9473](https://github.com/handsontable/handsontable/issues/9473)
- Fixed an issue where dragging-to-scroll on mobile didn't work properly in the RTL layout direction. [#9475](https://github.com/handsontable/handsontable/issues/9475)
- Fixed an issue where hiding columns with nested headers caused incorrect column width calculation (for the `stretchH: 'all'` option). [#9496](https://github.com/handsontable/handsontable/issues/9496)
- Fixed an issue where `ShortcutManager` unnecessarily handled `keyup` events with no `key` defined. [#9562](https://github.com/handsontable/handsontable/issues/9562)

## [12.0.1] - 2022-05-16

For more information on this release, see:
Expand Down
2 changes: 1 addition & 1 deletion docs/10.0/guides/columns/column-hiding.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ const hot = new Handsontable(container, {

By default, hidden columns are included in copying and pasting.

To exclude hidden columns from copying and pasting, in the `hiddenColumns` object, set the `copyPasteEnable` property to `false`:
To exclude hidden columns from copying and pasting, in the `hiddenColumns` object, set the `copyPasteEnabled` property to `false`:

::: example #example6
```js
Expand Down
2 changes: 1 addition & 1 deletion docs/10.0/guides/rows/row-hiding.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ const hot = new Handsontable(container, {

By default, hidden rows are included in copying and pasting.

To exclude hidden rows from copying and pasting, in the `hiddenRows` object, set the `copyPasteEnable` property to `false`:
To exclude hidden rows from copying and pasting, in the `hiddenRows` object, set the `copyPasteEnabled` property to `false`:

::: example #example6
```js
Expand Down
2 changes: 1 addition & 1 deletion docs/11.0/guides/columns/column-hiding.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ const hot = new Handsontable(container, {

By default, hidden columns are included in copying and pasting.

To exclude hidden columns from copying and pasting, in the `hiddenColumns` object, set the `copyPasteEnable` property to `false`:
To exclude hidden columns from copying and pasting, in the `hiddenColumns` object, set the `copyPasteEnabled` property to `false`:

::: example #example6
```js
Expand Down
2 changes: 1 addition & 1 deletion docs/11.0/guides/rows/row-hiding.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ const hot = new Handsontable(container, {

By default, hidden rows are included in copying and pasting.

To exclude hidden rows from copying and pasting, in the `hiddenRows` object, set the `copyPasteEnable` property to `false`:
To exclude hidden rows from copying and pasting, in the `hiddenRows` object, set the `copyPasteEnabled` property to `false`:

::: example #example6
```js
Expand Down
2 changes: 1 addition & 1 deletion docs/11.1/guides/columns/column-hiding.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ const hot = new Handsontable(container, {

By default, hidden columns are included in copying and pasting.

To exclude hidden columns from copying and pasting, in the `hiddenColumns` object, set the `copyPasteEnable` property to `false`:
To exclude hidden columns from copying and pasting, in the `hiddenColumns` object, set the `copyPasteEnabled` property to `false`:

::: example #example6
```js
Expand Down
2 changes: 1 addition & 1 deletion docs/11.1/guides/rows/row-hiding.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ const hot = new Handsontable(container, {

By default, hidden rows are included in copying and pasting.

To exclude hidden rows from copying and pasting, in the `hiddenRows` object, set the `copyPasteEnable` property to `false`:
To exclude hidden rows from copying and pasting, in the `hiddenRows` object, set the `copyPasteEnabled` property to `false`:

::: example #example6
```js
Expand Down
4 changes: 2 additions & 2 deletions docs/12.0/guides/cell-features/selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ To enable jumping across the left and right edges:

To jump across a vertical edge:
- When cell selection is on a row's first cell, press the left arrow key.
- When cell selection is on a row's last cell, press the right arrow key, or press <kbd>**TAB**</kbd>.
- When cell selection is on a row's last cell, press the right arrow key, or press <kbd>**Tab**</kbd>.

#### Jumping across horizontal edges

Expand All @@ -221,7 +221,7 @@ To enable jumping across the top and bottom edges:

To jump across a horizontal edge:
- When cell selection is on a column's first cell, press the up arrow key.
- When cell selection is on a column's last cell, press the down arrow key, or press <kbd>**ENTER**</kbd>.
- When cell selection is on a column's last cell, press the down arrow key, or press <kbd>**Enter**</kbd>.

## Related keyboard shortcuts

Expand Down
2 changes: 1 addition & 1 deletion docs/12.0/guides/cell-functions/cell-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ If any of those events is triggered, [`EditorManager`](@/api/baseEditor.md) call

### Overriding EditorManager default behaviour

You may want to change the default events that causes editor to open or close. For example, your editor might use <kbd>**ARROW_UP**</kbd> and <kbd>**ARROW_DOWN**</kbd> events to perform some actions (for example increasing or decreasing cell value) and you don't want [`EditorManager`](@/api/baseEditor.md) to close the editor when user press those keys. That's why [`EditorManager`](@/api/baseEditor.md) runs [`beforeKeyDown`](@/api/hooks.md#beforekeydown) hook before processing user events. If you register a listener for [`beforeKeyDown`](@/api/hooks.md#beforekeydown), that call `stopImmediatePropagation()` on `event` object [`EditorManager`](@/api/baseEditor.md) won perform its default action. More on overriding [`EditorManager`](@/api/baseEditor.md)'s behaviour in section "SelectEditor - creating editor from scratch".
You may want to change the default events that causes editor to open or close. For example, your editor might use <kbd>**Arrow Up**</kbd> and <kbd>**Arrow Down**</kbd> events to perform some actions (for example increasing or decreasing cell value) and you don't want [`EditorManager`](@/api/baseEditor.md) to close the editor when user press those keys. That's why [`EditorManager`](@/api/baseEditor.md) runs [`beforeKeyDown`](@/api/hooks.md#beforekeydown) hook before processing user events. If you register a listener for [`beforeKeyDown`](@/api/hooks.md#beforekeydown), that call `stopImmediatePropagation()` on `event` object [`EditorManager`](@/api/baseEditor.md) won perform its default action. More on overriding [`EditorManager`](@/api/baseEditor.md)'s behaviour in section "SelectEditor - creating editor from scratch".

You should now have a better understanding on how [`EditorManager`](@/api/baseEditor.md) works. Let's go a bit deeper and see what methods every editor class must implement and what those methods do.

Expand Down
2 changes: 1 addition & 1 deletion docs/12.0/guides/columns/column-hiding.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ const hot = new Handsontable(container, {

By default, hidden columns are included in copying and pasting.

To exclude hidden columns from copying and pasting, in the [`hiddenColumns`](@/api/hiddenColumns.md) object, set the [`copyPasteEnable`](@/api/hiddenColumns.md) property to `false`:
To exclude hidden columns from copying and pasting, in the [`hiddenColumns`](@/api/hiddenColumns.md) object, set the [`copyPasteEnabled`](@/api/hiddenColumns.md) property to `false`:

::: example #example6
```js
Expand Down
2 changes: 1 addition & 1 deletion docs/12.0/guides/rows/row-hiding.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ const hot = new Handsontable(container, {

By default, hidden rows are included in copying and pasting.

To exclude hidden rows from copying and pasting, in the `hiddenRows` object, set the `copyPasteEnable` property to `false`:
To exclude hidden rows from copying and pasting, in the `hiddenRows` object, set the `copyPasteEnabled` property to `false`:

::: example #example6
```js
Expand Down
2 changes: 1 addition & 1 deletion docs/12.1/guides/columns/column-hiding.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ const hot = new Handsontable(container, {

By default, hidden columns are included in copying and pasting.

To exclude hidden columns from copying and pasting, in the [`hiddenColumns`](@/api/hiddenColumns.md) object, set the [`copyPasteEnable`](@/api/hiddenColumns.md) property to `false`:
To exclude hidden columns from copying and pasting, in the [`hiddenColumns`](@/api/hiddenColumns.md) object, set the [`copyPasteEnabled`](@/api/hiddenColumns.md) property to `false`:

::: example #example6
```js
Expand Down
2 changes: 1 addition & 1 deletion docs/12.1/guides/rows/row-hiding.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ const hot = new Handsontable(container, {

By default, hidden rows are included in copying and pasting.

To exclude hidden rows from copying and pasting, in the `hiddenRows` object, set the `copyPasteEnable` property to `false`:
To exclude hidden rows from copying and pasting, in the `hiddenRows` object, set the `copyPasteEnabled` property to `false`:

::: example #example6
```js
Expand Down
4 changes: 2 additions & 2 deletions docs/README-EDITING.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,11 +162,11 @@ To check for broken links:
```bash
npm run docs:build
```
3. Check for the broken links, run:
3. Check for broken links. From the `docs` directory, run:
```bash
npm run docs:check-links
```
5. Open the broken links report: `./docs/report-check-links.xlsx`.
4. Open the broken links report: `/docs/report-check-links.xlsx`.
## Markdown containers
Expand Down
4 changes: 2 additions & 2 deletions docs/next/guides/cell-features/selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ To enable jumping across the left and right edges:

To jump across a vertical edge:
- When cell selection is on a row's first cell, press the left arrow key.
- When cell selection is on a row's last cell, press the right arrow key, or press <kbd>**TAB**</kbd>.
- When cell selection is on a row's last cell, press the right arrow key, or press <kbd>**Tab**</kbd>.

#### Jumping across horizontal edges

Expand All @@ -221,7 +221,7 @@ To enable jumping across the top and bottom edges:

To jump across a horizontal edge:
- When cell selection is on a column's first cell, press the up arrow key.
- When cell selection is on a column's last cell, press the down arrow key, or press <kbd>**ENTER**</kbd>.
- When cell selection is on a column's last cell, press the down arrow key, or press <kbd>**Enter**</kbd>.

## Related keyboard shortcuts

Expand Down
2 changes: 1 addition & 1 deletion docs/next/guides/cell-functions/cell-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ If any of those events is triggered, [`EditorManager`](@/api/baseEditor.md) call

### Overriding EditorManager default behaviour

You may want to change the default events that causes editor to open or close. For example, your editor might use <kbd>**ARROW_UP**</kbd> and <kbd>**ARROW_DOWN**</kbd> events to perform some actions (for example increasing or decreasing cell value) and you don't want [`EditorManager`](@/api/baseEditor.md) to close the editor when user press those keys. That's why [`EditorManager`](@/api/baseEditor.md) runs [`beforeKeyDown`](@/api/hooks.md#beforekeydown) hook before processing user events. If you register a listener for [`beforeKeyDown`](@/api/hooks.md#beforekeydown), that call `stopImmediatePropagation()` on `event` object [`EditorManager`](@/api/baseEditor.md) won perform its default action. More on overriding [`EditorManager`](@/api/baseEditor.md)'s behaviour in section "SelectEditor - creating editor from scratch".
You may want to change the default events that causes editor to open or close. For example, your editor might use <kbd>**Arrow Up**</kbd> and <kbd>**Arrow Down**</kbd> events to perform some actions (for example increasing or decreasing cell value) and you don't want [`EditorManager`](@/api/baseEditor.md) to close the editor when user press those keys. That's why [`EditorManager`](@/api/baseEditor.md) runs [`beforeKeyDown`](@/api/hooks.md#beforekeydown) hook before processing user events. If you register a listener for [`beforeKeyDown`](@/api/hooks.md#beforekeydown), that call `stopImmediatePropagation()` on `event` object [`EditorManager`](@/api/baseEditor.md) won perform its default action. More on overriding [`EditorManager`](@/api/baseEditor.md)'s behaviour in section "SelectEditor - creating editor from scratch".

You should now have a better understanding on how [`EditorManager`](@/api/baseEditor.md) works. Let's go a bit deeper and see what methods every editor class must implement and what those methods do.

Expand Down
2 changes: 1 addition & 1 deletion docs/next/guides/columns/column-hiding.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ const hot = new Handsontable(container, {

By default, hidden columns are included in copying and pasting.

To exclude hidden columns from copying and pasting, in the [`hiddenColumns`](@/api/hiddenColumns.md) object, set the [`copyPasteEnable`](@/api/hiddenColumns.md) property to `false`:
To exclude hidden columns from copying and pasting, in the [`hiddenColumns`](@/api/hiddenColumns.md) object, set the [`copyPasteEnabled`](@/api/hiddenColumns.md) property to `false`:

::: example #example6
```js
Expand Down
2 changes: 1 addition & 1 deletion docs/next/guides/rows/row-hiding.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ const hot = new Handsontable(container, {

By default, hidden rows are included in copying and pasting.

To exclude hidden rows from copying and pasting, in the `hiddenRows` object, set the `copyPasteEnable` property to `false`:
To exclude hidden rows from copying and pasting, in the `hiddenRows` object, set the `copyPasteEnabled` property to `false`:

::: example #example6
```js
Expand Down
4 changes: 2 additions & 2 deletions docs/next/guides/rows/row-moving.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ canonicalUrl: /row-moving

This page shows how to move rows in Handsontable.

## Enabling plugins
## Enabling the `ManualRowMove` plugin

To enable move features, set the [`manualRowMove](@/api/options.md#manualrowmove) option to `true`.
To enable row moving, set the [`manualRowMove`](@/api/options.md#manualrowmove) option to `true`.

A draggable move handle appears above the selected row header. You can click and drag it to any location in the row header body.

Expand Down
Loading

0 comments on commit 127f82c

Please sign in to comment.