Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@geins/ralph-module-streamify
Advanced tools
@geins/ralph-module-streamify - npm Package Compare versions
Comparing version 1.0.4 to 1.1.4
| { | ||
| "name": "@geins/ralph-module-streamify", | ||
| "version": "1.0.4", | ||
| "version": "1.1.4", | ||
| "description": "Streamify module for Geins PWA Storefront Ralph", | ||
| "author": { | ||
| "name": "arvidsson-geins" | ||
| }, | ||
| "author": "arvidsson-geins", | ||
| "keywords": [ | ||
@@ -36,3 +34,15 @@ "vue", | ||
| }, | ||
| "dependencies": {} | ||
| "dependencies": {}, | ||
| "directories": { | ||
| "lib": "lib", | ||
| "test": "test" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/geins-io/ralph-module-streamify.git" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/geins-io/ralph-module-streamify/issues" | ||
| }, | ||
| "homepage": "https://github.com/geins-io/ralph-module-streamify#readme" | ||
| } |
@@ -17,3 +17,3 @@ [![NPM Package][npm]][npm-url] | ||
| Module can be used in any page of your storefront and is configuerd to work with Geins Cart out-of-box. Module can be added via Geins CMS or any CMS of your choice. | ||
| Module can be used in any page of your storefront and is configuerd to work with Geins Cart out-of-box for a seamless liveshopping experince. Module can be added via Geins CMS or any CMS of your choice. | ||
@@ -46,6 +46,2 @@ ## Installation | ||
| ### 3. CaWidgetJson | ||
| ### 3. If you already have overridden the CaWidgetJson | ||
| ## Module Options | ||
@@ -64,14 +60,12 @@ | ||
| Add component to desired page of your storefront. Either by cms or as a component. You can add id to the component to show a specific stream. If no id is added the component will show the next upcoming or live stream. | ||
| Add to desired page of your storefront. Either by cms or as a component. You can add id to the component to show a specific stream. If no id is added the component will show the next upcoming or live stream. | ||
| ## Component | ||
| ## Components | ||
| Module adds two components to your storefront. `GeinsStreamifyPlayer` and `GeinsWidgetStreamify`. | ||
| Component name is `CaWidgetStreamify`. | ||
| ### GeinsStreamifyPlayer | ||
| This component is used to show the streamify player. It is used by the `GeinsWidgetStreamify` component. You can use it directly in your page if you want to add the player directly to your page. If | ||
| ### Events | ||
| #### Properties | ||
| The component emits events that translates to your Geins Cart. | ||
| ### Properties | ||
| The properties of the component are one to one with the [Streamify Floating Player API](https://developer.streamify.io/#floating-player-js-introduction). You can add any property to the component and it will be passed to the API. | ||
@@ -81,4 +75,4 @@ | ||
| | --------------- | ------- | ------------- | -------- | -------------------------------------------------------------------------------------------------- | | ||
| | configuration | Object | - | No | Configuration object to set properties for the widget | | ||
| | id | String | - | Yes | The ID of the stream | | ||
| | configuration | Object | - | No | Configuration object to set properties for the widget. Used by `GeinsWidgetStreamify` | | ||
| | id | String | - | NO | The ID of the stream. If no ID is present player takes the nearest upcomming stream | | ||
| | orientation | String | 'landscape' | No | The orientation of the player. Possible values: 'landscape' or 'portrait' | | ||
@@ -95,6 +89,26 @@ | playButton | Boolean | false | No | Determines whether to show the play button | | ||
| _The `configuration` object will be overriden by any property added to the component._ | ||
| #### Use as a component or with any CMS | ||
| ### Use with Geins CMS | ||
| Add the component to your page. Add the id of the stream you want to show as a property to the component. You can find the id in the Streamify App or in the Streamify. | ||
| ```vue | ||
| <GeinsStreamifyPlayer id="your-stream-id" /> | ||
| ``` | ||
| ### GeinsWidgetStreamify | ||
| The widget is a wrapper around the `GeinsStreamifyPlayer` component. It is used to add the component via CMS. It is not needed if you add the component directly to your page. | ||
| #### Properties | ||
| The properties of the component are one to one with the [Streamify Floating Player API](https://developer.streamify.io/#floating-player-js-introduction). You can add any property to the component and it will be passed to the API. | ||
| | Property | Type | Default Value | Required | Description | | ||
| | --------------- | ------- | ------------- | -------- | -------------------------------------------------------------------------------------------------- | | ||
| | configuration | Object | - | No | Configuration object to set properties for the `GeinsStreamifyPlayer` | | ||
| `Configuration` property is parsed by [@geins/ralph-module-cms-json-container](https://www.npmjs.com/package/@geins/ralph-module-cms-json-container). | ||
| #### Use with Geins CMS | ||
| Add a `JSON Widget` to your page in the [Geins CMS](https://docs.geins.io/docs/launchpads/web/content). Add the following JSON to your widget. Replace `your-stream-id` with the id of the stream you want to show. You can find the id in the Streamify App or in the Streamify. | ||
@@ -115,14 +129,7 @@ | ||
| All properties of the Stremify Floating Player JS can be added to the JSON. Read documentation [here](https://developer.streamify.io/#floating-player-js-introduction). Use the same name as in the streamify documentation to add properties to the JSON. The data part of the JSON is passed to the component as the `configuration` property. | ||
| All properties of the Stremify Floating Player JS can be added to the JSON. Read documentation [here](https://developer.streamify.io/#floating-player-js-introduction). Use the same name as in the streamify documentation to add properties to the JSON. | ||
| _If you want to show the next upcoming or live stream, remove the `id` property from the JSON._ | ||
| ### As a component or with any CMS | ||
| Add the component to your page. Add the id of the stream you want to show as a property to the component. You can find the id in the Streamify App or in the Streamify. | ||
| ```vue | ||
| <CaStreamify id="your-stream-id" /> | ||
| ``` | ||
| ### Tips! | ||
@@ -129,0 +136,0 @@ |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No bug tracker
MaintenancePackage does not have a linked bug tracker in package.json.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by13.82%
23094
- Number of package files
- increased by11.11%
20
- Lines of code
- increased by3.55%
204
- Number of low maintenance alerts
- decreased by-100%
0
- Number of low quality alerts
- decreased by-100%
0
- Number of lines in readme file
- increased by5.3%
139
- Number of low supply chain risk alerts
- decreased by-25%
3
No dependency changes