From 52249cad6aeb7614b616648fc9b2fd917565a1b4 Mon Sep 17 00:00:00 2001 From: Takuma Kira Date: Wed, 16 Sep 2020 22:42:31 +0900 Subject: [PATCH] feat(segment): make the document positive closes #22048 --- core/src/components.d.ts | 4 ++-- core/src/components/segment/readme.md | 2 +- core/src/components/segment/segment.tsx | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/core/src/components.d.ts b/core/src/components.d.ts index adee4f1c1db..5a7b1af9305 100644 --- a/core/src/components.d.ts +++ b/core/src/components.d.ts @@ -2059,7 +2059,7 @@ export namespace Components { */ "scrollable": boolean; /** - * If `false`, the gesture to drag the indicator between the buttons will be disabled. + * If `true`, users will be able to swipe between segment buttons to activate them. */ "swipeGesture": boolean; /** @@ -5357,7 +5357,7 @@ declare namespace LocalJSX { */ "scrollable"?: boolean; /** - * If `false`, the gesture to drag the indicator between the buttons will be disabled. + * If `true`, users will be able to swipe between segment buttons to activate them. */ "swipeGesture"?: boolean; /** diff --git a/core/src/components/segment/readme.md b/core/src/components/segment/readme.md index 995db5d12dc..c0db0f30513 100644 --- a/core/src/components/segment/readme.md +++ b/core/src/components/segment/readme.md @@ -572,7 +572,7 @@ export default defineComponent({ | `disabled` | `disabled` | If `true`, the user cannot interact with the segment. | `boolean` | `false` | | `mode` | `mode` | The mode determines which platform styles to use. | `"ios" \| "md"` | `undefined` | | `scrollable` | `scrollable` | If `true`, the segment buttons will overflow and the user can swipe to see them. In addition, this will disable the gesture to drag the indicator between the buttons in order to swipe to see hidden buttons. | `boolean` | `false` | -| `swipeGesture` | `swipe-gesture` | If `false`, the gesture to drag the indicator between the buttons will be disabled. | `boolean` | `true` | +| `swipeGesture` | `swipe-gesture` | If `true`, users will be able to swipe between segment buttons to activate them. | `boolean` | `true` | | `value` | `value` | the value of the segment. | `null \| string \| undefined` | `undefined` | diff --git a/core/src/components/segment/segment.tsx b/core/src/components/segment/segment.tsx index 1a5e973eeda..2a85f735901 100644 --- a/core/src/components/segment/segment.tsx +++ b/core/src/components/segment/segment.tsx @@ -50,7 +50,7 @@ export class Segment implements ComponentInterface { @Prop() scrollable = false; /** - * If `false`, the gesture to drag the indicator between the buttons will be disabled. + * If `true`, users will be able to swipe between segment buttons to activate them. */ @Prop() swipeGesture = true;