From 8c4009090b3ed07abf96e5f9737e65ddaaa516cc Mon Sep 17 00:00:00 2001 From: Doyeon Kim Date: Wed, 6 Oct 2021 15:33:24 +0900 Subject: [PATCH] docs : update PinchZoom README (#139) Add preview, props, and installation. --- packages/PinchZoom/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/packages/PinchZoom/README.md b/packages/PinchZoom/README.md index aa74086e..e3050afb 100644 --- a/packages/PinchZoom/README.md +++ b/packages/PinchZoom/README.md @@ -1,3 +1,24 @@ # PinchZoom > [PinchZoom] has ability to zoom in / out images or component. + +#### Preview + +![pinchzoom](https://user-images.githubusercontent.com/50297117/136137789-b65265d6-6580-4465-9adb-f29d0ed44d46.gif) + +## Props + +| Props | Types | Required | Default | +| ----------------------- | --------------------------------------------- | -------- | ------- | +| style | ViewStyle | optional | - | +| onScaleChanged | (_value_: _number_): void | optional | - | +| onTranslateChanged | (_valueXY_: {x: _number_; y: _number_}): void | optional | - | +| onRelease | void | optional | - | +| allowEmpty | {x?: _boolean_; y?: _boolean_} | optional | - | +| fixOverflowAfterRelease | boolean | optional | true | + +## Installation + +``` +yarn add @dooboo-ui/pinch-zoom +```