From 05e53f9084e1ad615fe1fede50657aa746c42582 Mon Sep 17 00:00:00 2001 From: WuMingDao <146366930+WuMingDao@users.noreply.github.com> Date: Sun, 9 Nov 2025 03:08:23 +0800 Subject: [PATCH] docs: fix typo and grammar in readme.md --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index bcea2d29..ce74dde7 100755 --- a/README.md +++ b/README.md @@ -128,7 +128,7 @@ app.component("VueUiRadar", VueUiRadar); app.mount("#app"); ``` -Or you can import just what you need in your files: +Or you can import just what you need into your files: ```js @@ -208,7 +208,7 @@ customFormat: ({ seriesIndex, datapoint, series, config }) => { Data labels can be customized using the `formatter` config attribute (since v2.3.29 on all chart components): ``` -// the formatter attribute is generally placed under label or dataLabel config attribute objects +// the formatter attribute is generally placed under the label or dataLabel config attribute objects const config = ref({ formatter: ({ value, config }) => { @@ -270,7 +270,7 @@ It is recommended to set the show legend config attribute to false, to hide the ## Tooltip #tooltip-before & #tooltip-after slots Customize tooltip contents with #tooltip-before and #tooltip-after slots. -It is that easy to include an image, another chart or any other content into your tooltips. It's an alternative to the config option tooltip.customFormat, in case richer tooltip content is needed. +Is it that easy to include an image, another chart or any other content into your tooltips. It's an alternative to the config option tooltip.customFormat, in case richer tooltip content is needed. Both slots expose the following object: @@ -333,13 +333,13 @@ The following charts bear these slots: ``` -The #tooltip-before & #tooltip-after slots also works when using the VueDataUi universal component, if the component it wraps supports them. +The #tooltip-before & #tooltip-after slots also work when using the VueDataUi universal component, if the component it wraps supports them. ## Add a watermark using the #watermark slot @@ -539,8 +539,8 @@ All names of available icons are available in the vue-data-ui.d.ts file under th # User options -User options menu is accessible in the burger menu located on the top right of charts, and visible by default. -To hide user options menu, set config.userOptions.show to false: +User options menu is accessible in the burger menu located on the top right of the charts, and visible by default. +To hide the user options menu, set config.userOptions.show to false: ```js const config = ref({ @@ -551,7 +551,7 @@ const config = ref({ }) ``` -User options menu can be set to appear only when hovering the component: +The user options menu can be set to appear only when hovering over the component: ```js const config = ref({ @@ -563,7 +563,7 @@ const config = ref({ }); ``` -Predefined actions in user options menu depend on the type of chart. Some charts have more or less actions available. Action buttons contain an predefined icons by default. +Predefined actions in the user options menu depend on the type of chart. Some charts have more or fewer actions available. Action buttons contain predefined icons by default. To hide a given action, set the userOption.buttons, for example: @@ -596,7 +596,7 @@ What happens when the button is clicked is taken care of by the component, excep ``` -You can pass a callback trhough the config, for each button, to override the default behavior: +You can pass a callback through the config, for each button, to override the default behavior: ```ts const config = { @@ -611,7 +611,7 @@ const config = { csv: (csvStr: string) => { console.log(csvStr); }, - // the other atributes also have the same names as the buttons + // the other attributes also have the same names as the buttons }, }, }; @@ -752,7 +752,7 @@ Accepted color formats: HEX, RGB, HSL, named colors. # Responsive charts By default, all charts will scale to the width of their container. -However the folowing charts can be made fully responsive, making them better to use in resizable containers: +However the following charts can be made fully responsive, making them better to use in resizable containers: | Component | Responsive feature implemented | | --------------------------- | ------------------------------ | @@ -827,7 +827,7 @@ The following charts use the LTTB algorithm (Largest-Triangle-Three-Bucket) beyo | Component | Default Threshold | Remark | | --------------- | ----------------- | --------------------------------------------------------- | | VueUiXy | 1095 | | -| VueUiXyCanvas | 10000 | Since this chart uses canvas, threhsold can be set higher | +| VueUiXyCanvas | 10000 | Since this chart uses canvas, the threshold can be set higher | | VueUiQuadrant | 1095 | | | VueUiScatter | 1095 | | | VueUiSparkline | 1095 | | @@ -884,7 +884,7 @@ A pattern element must be used inside this slot. It will be injected inside a de ```html