Skip to content

Commit

Permalink
fix(docs): update rkModalImg docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Artur Yorsh authored and malashkevich committed Sep 19, 2018
1 parent ef6745f commit 586b4f2
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<a name="3.1.0"></a>
## [3.1.0](https://github.com/akveo/react-native-ui-kitten/compare/v3.0.1...v3.1.0) (2018-09-19)


### Bug Fixes

* **rkTextInput:** non-editable rkTextInput crash on Android ([e755ce1](https://github.com/akveo/react-native-ui-kitten/commit/e755ce1))
Expand All @@ -18,6 +17,12 @@
* **rkGallery:** component implementation ([2a9f652](https://github.com/akveo/react-native-ui-kitten/commit/2a9f652))
* **rkGalleryImage:** component implementation ([794b117](https://github.com/akveo/react-native-ui-kitten/commit/794b117))


### Notes

* **rkModalImg:** this component is deprecated since 3.1.0 version. Will be completely deleted in 3.2.0 version.
Use [rkGallery](https://akveo.github.io/react-native-ui-kitten/#/docs/ui-components/rkgallery) or [rkGalleryImage](https://akveo.github.io/react-native-ui-kitten/#/docs/ui-components/rkgalleryimage) instead.

<a name="3.0.1"></a>
## [3.0.1](https://github.com/akveo/react-native-ui-kitten/compare/v3.0.0...v3.0.1) (2018-04-25)

Expand Down
13 changes: 11 additions & 2 deletions src/components/image/rkModalImg.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,22 @@ import { RkComponent } from '../rkComponent';
import { RkTheme } from '../../styles/themeManager';

/**
* `RkModalImg` is extension of basic `Image` that also opens it in full screen on tap.
*
* @deprecated since version 3.1.0. Will be deleted in version 3.2.0.
* Use `RkGallery` or `RkGalleryImage` instead.
*
* `RkModalImg` is extension of basic `Image` that also opens it in full screen on tap.
*
* @extends React.Component
*
* @example Important notes
*
* Deprecated since version 3.1.0. Will be deleted in version 3.2.0.
* Use `RkGallery` or `RkGalleryImage` instead.
*
* ```
* <RkGalleryImage source={require('path/to/my-awesome-pic.jpg')}/>
* ```
*
* @example Simple usage:
*
* ```
Expand Down

0 comments on commit 586b4f2

Please sign in to comment.