📝 docs: add docs for pause prop

megasanjay · Sep 20, 2023 · 5dde9ae · 5dde9ae · vercel · Sep 20, 2023
1 parent b9b6ba2
commit 5dde9ae
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -123,6 +123,7 @@ More detailed explanations are provided in the [documentation](https://vue3-marq
 | gradient       | Boolean                                | false           | Whether to show a gradient overlay                                                     |
 | gradientColor  | Array of 3 RGB values                  | [255, 255, 255] | The RGB colors for the color of the gradient                                           |
 | gradientLength | String                                 | 200px           | Length of portion of the container edges that should be taken by the gradient overlay  |
+| pause          | Boolean                                | false           | A reactive prop to pause the marquee                                                   |
 | pauseOnHover   | Boolean                                | false           | Whether to pause the marquee on hover                                                  |
 | pauseOnClick   | Boolean                                | false           | Whether to pause the marquee when you hold the right click button                      |
 | clone          | Boolean                                | false           | Whether to clone the content if you want no empty spaces in the animation              |

diff --git a/docs/content/1.introduction/1.installation.md b/docs/content/1.introduction/1.installation.md
@@ -27,7 +27,7 @@ pnpm add vue3-marquee@latest
 ::
 
 ::alert{type="warning"}
-If you upgrading from v3 to v4, please remove the `dist/style.css` import from your project. This css is now imported automatically by the plugin. For more information, see [Migrating from v3 to v4](/introduction/v4).
+If you are upgrading from v3 to v4, please remove the `dist/style.css` import from your project. This css is now imported automatically by the plugin. For more information, see [Migrating from v3 to v4](/introduction/v4).
 ::
 
 ::alert{type="success"}

diff --git a/docs/content/1.introduction/2.vue-3.md b/docs/content/1.introduction/2.vue-3.md
@@ -1,7 +1,7 @@
 # Usage with Vue 3
 
 ::alert{type="warning"}
-If you upgrading from v3 to v4, please remove the `dist/style.css` import from your main.js or main.ts file. This css is now imported automatically by the plugin.
+If you are upgrading from v3 to v4, please remove the `dist/style.css` import from your main.js or main.ts file. This css is now imported automatically by the plugin.
 ::
 
 ## Register the component

diff --git a/docs/content/1.introduction/3.nuxt-3.md b/docs/content/1.introduction/3.nuxt-3.md
@@ -1,7 +1,7 @@
 # Usage with Nuxt 3
 
 ::alert{type="warning"}
-If you upgrading from v3 to v4, please remove the `dist/style.css` import from your `app.vue` file. This css is now imported automatically by the plugin.
+If you are upgrading from v3 to v4, please remove the `dist/style.css` import from your `app.vue` file. This css is now imported automatically by the plugin.
 ::
 
 ## Register the component

diff --git a/docs/content/2.api/1.props.md b/docs/content/2.api/1.props.md
@@ -68,6 +68,14 @@ What portion of the container edges should be taken by the gradient overlay.
 
 [`gradientLength demo`](/examples#image-marquee-with-a-gradient)
 
+## `pause` :badge[new]{type="success"}
+
+A reactive prop to pause the marquee animation.
+
+| Type    | Default value | Required | Accepted values   |
+| ------- | ------------- | -------- | ----------------- |
+| Boolean | `false`       | no       | `true` or `false` |
+
 ## `pauseOnHover`
 
 Whether to pause the marquee on hover

diff --git a/docs/content/3.examples.md b/docs/content/3.examples.md
@@ -216,7 +216,7 @@ Vertical marquees are still experimental. All props and events are supported, bu
 ::
 
 ::alert{type="success"}
-All props (including `clone`) and events are supported for vertical marquees. The only difference is that the [`vertical`](/api/props#vertical) prop is set to `true`.
+All props (including `clone`) and events are supported for vertical marquees. The only difference is that the [`vertical`](/api/props#vertical) prop needs to be set to `true`.
 ::
 
 ::code-group

diff --git a/packages/vue3-marquee/README.md b/packages/vue3-marquee/README.md
@@ -123,6 +123,7 @@ More detailed explanations are provided in the [documentation](https://vue3-marq
 | gradient       | Boolean                                | false           | Whether to show a gradient overlay                                                     |
 | gradientColor  | Array of 3 RGB values                  | [255, 255, 255] | The RGB colors for the color of the gradient                                           |
 | gradientLength | String                                 | 200px           | Length of portion of the container edges that should be taken by the gradient overlay  |
+| pause          | Boolean                                | false           | A reactive prop to pause the marquee                                                   |
 | pauseOnHover   | Boolean                                | false           | Whether to pause the marquee on hover                                                  |
 | pauseOnClick   | Boolean                                | false           | Whether to pause the marquee when you hold the right click button                      |
 | clone          | Boolean                                | false           | Whether to clone the content if you want no empty spaces in the animation              |