Skip to content

Commit 6e53603

Browse files
authored
Fixes to types and spelling (#900)
1 parent 2b5a165 commit 6e53603

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

MAINTAINING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Series of github actions are used to automate the library [releases](https://git
99
`release-drafter` action updates a draft of release notes after each push. Its based on labels and the commit messages, so its important to label pull requests and have clean commits. If the draft contains commits that do not fall under any heading, those commits should be labeled and the drafter re-run from [actions](https://github.com/chartjs/chartjs-plugin-zoom/actions).
1010

1111
1. update `master` `package.json` version using [semver](https://semver.org/) semantic
12-
1. update the tag and version in the release draft to match `package.json`. Mark it as `pre-release` if you would like to publis with `next` tag on [npmjs](https://www.npmjs.com/package/chartjs-plugin-zoom)
12+
1. update the tag and version in the release draft to match `package.json`. Mark it as `pre-release` if you would like to publish with `next` tag on [npmjs](https://www.npmjs.com/package/chartjs-plugin-zoom)
1313
1. publish the release in GitHub. Publishing will trigger the `publish-npm` action. You can monitor the process in [actions](https://github.com/chartjs/chartjs-plugin-zoom/actions)
1414

1515
### Automated Tasks

docs/guide/options.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ const chart = new Chart('id', {
4545
| ---- | --------- | -----------
4646
| `onPan` | `{chart}` | Called while the chart is being panned
4747
| `onPanComplete` | `{chart}` | Called once panning is completed
48-
| `onPanRejected` | `{chart,event}` | Called when panning is rejected due to missing modifier key. `event` is the a [hammer event](https://hammerjs.github.io/api#event-object) that failed
48+
| `onPanRejected` | `{chart,event}` | Called when panning is rejected due to missing modifier key. `event` is a [Hammer event](https://hammerjs.github.io/api#event-object) that failed
4949
| `onPanStart` | `{chart,event,point}` | Called when panning is about to start. If this callback returns false, panning is aborted and `onPanRejected` is invoked
5050

5151
## Zoom
@@ -105,7 +105,7 @@ The `drawTime` option for zooming determines where in the chart lifecycle the dr
105105
| ---- | --------- | -----------
106106
| `onZoom` | `{chart}` | Called while the chart is being zoomed
107107
| `onZoomComplete` | `{chart}` | Called once zooming is completed
108-
| `onZoomRejected` | `{chart,event}` | Called when zoom is rejected due to missing modifier key. `event` is the a [hammer event](https://hammerjs.github.io/api#event-object) that failed
108+
| `onZoomRejected` | `{chart,event}` | Called when zoom is rejected due to missing modifier key. `event` is a [Hammer event](https://hammerjs.github.io/api#event-object) that failed
109109
| `onZoomStart` | `{chart,event,point}` | Called when zooming is about to start. If this callback returns false, zooming is aborted and `onZoomRejected` is invoked
110110

111111
## Limits

docs/samples/wheel/click-zoom.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
::: tip NOTE
44

55
The following text is there on purpose, so the page is scrollable.
6-
This demoes that the chart does not consume the wheel until clicked.
6+
This demos that the chart does not consume the wheel until clicked.
77

88
:::
99

types/options.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ export interface ZoomOptions {
116116
*/
117117
onZoomRejected?: (context: { chart: Chart, event: Event }) => void;
118118

119-
onZoomStart?: (context: { chart: Chart, event: Event, point: Point }) => void;
119+
onZoomStart?: (context: { chart: Chart, event: Event, point: Point }) => boolean | undefined;
120120
}
121121

122122
/**
@@ -137,7 +137,7 @@ export interface PanOptions {
137137
* return 'xy';
138138
* },
139139
*/
140-
mode?: Mode | { (char: Chart): Mode };
140+
mode?: Mode | { (chart: Chart): Mode };
141141

142142
/**
143143
* Modifier key required for panning with mouse
@@ -165,7 +165,7 @@ export interface PanOptions {
165165

166166
/**
167167
* Function called when pan fails because modifier key was not detected.
168-
* event is the a hammer event that failed - see https://hammerjs.github.io/api#event-object
168+
* event is the Hammer event that failed - see https://hammerjs.github.io/api#event-object
169169
*/
170170
onPanRejected?: (context: { chart: Chart, event: HammerInput }) => void;
171171

0 commit comments

Comments
 (0)