diff --git a/README.md b/README.md index c12902d..9366551 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,46 @@ or you can use [npm module](https://www.npmjs.com/package/sirv-media-viewer-scri ``` npm install --save vue-js-sirv-viewer ``` -## usage +## register as plugin ``` import SirvViewer from 'vue-js-sirv-viewer'; + Vue.use(SirvViewer); ``` +## basic usage +``` + +``` +- `:id` - viewer id +- `:data-src` - using for `*.view` files, overrides `:slides` +- `data-options` - [viewer options](https://sirv.com/help/articles/sirv-media-viewer/) +- `:slides` - Array with slide sources. Sources can be String or Object. +String can be just url link +Object has additional props: + * `id` - Slide id [String] + * `src` - Source [String] + * `dataOptions` - Local slide options [Object] + * `type` - Type of slide [String]. The available props are: `spin`, `zoom`, `image`, `youtube`, `vimeo`, `video`, `html` + * `dataThumbnailImage` - Custom thumbnail image [String] + * `dataThumbnailHtml` - Custom thumbnail html [String] + * `dataDisabled` - Disable slide [Boolean] + * `dataSwipeDisabled` - Disable slide swipe [Boolean] + * `dataHiddenSelector` - Hide selector [Boolean] + * `dataPinned` - Pinned selector [String]. The available props are: `left`, `right` + * `staticImage` - Static image [Boolean]. -[Examples](https://test1.sirv.com/sergey/test/index.html) +[Examples](https://test1.sirv.com/sergey/vue/index.html) -[Documentation](https://sirv.com/help/articles/sirv-media-viewer/) +[Sirv Media Viewer documentation](https://sirv.com/help/articles/sirv-media-viewer/) \ No newline at end of file diff --git a/demo/src/components/Example3.vue b/demo/src/components/Example3.vue index 65fdbeb..0087e44 100644 --- a/demo/src/components/Example3.vue +++ b/demo/src/components/Example3.vue @@ -70,13 +70,13 @@
  • id
    - Slide id [String]
  • src
    - Source [String]
  • dataOptions
    - Local slide options [Object]
  • -
  • type
    - Type of slide [String]. All types
    spin, zoom, image, 'youtube', 'vimeo', 'video', 'html'
  • +
  • type
    - Type of slide [String]. The available props are:
    spin, zoom, image, 'youtube', 'vimeo', 'video', 'html'
  • dataThumbnailImage
    - Custom thumbnail image [String]
  • dataThumbnailHtml
    - Custom thumbnail html [String]
  • dataDisabled
    - Disable slide [Boolean]
  • dataSwipeDisabled
    - Disable slide swipe [Boolean]
  • dataHiddenSelector
    - Hide selector [Boolean]
  • -
  • dataPinned
    - Pinned selector [String].
    left, right
  • +
  • dataPinned
    - Pinned selector [String]. The available props are:
    left, right
  • staticImage
    - Static image [Boolean].
  • diff --git a/package.json b/package.json index 68a3a97..682ca09 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "vue-js-sirv-viewer", - "version": "1.0.0-beta.5", + "version": "1.0.0-beta.6", "description": "Sirv Media Viewer for Vue.js", "author": "sergey ", "scripts": {