npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@okendo/okendo-widgets-vue

v1.5.2

Published

Okendo components for Vue apps

Downloads

1,367

Readme

Okendo Reviews Vue Components

Library of Okendo widgets for use in Vue apps.

Installation

1. Install the package

npm install @okendo/okendo-widgets-vue

2. Import the default css

@import '~@okendo/okendo-widgets-vue/dist/css/main.min.css';

3. Install Flickity, the library which handles the media sliders and galleries. Please ensure you have the correct license for your usage. You can install the package through npm or add the .js file directly to your html <head>

<script src="https://unpkg.com/flickity@2/dist/flickity.pkgd.min.js" async></script>

4. Run configureOkendo in your app root to set the subscriberId (API key unique to each store) and any widget settings (following the schema below). This only needs to run once before your Okendo components are mounted, i.e. in App.vue or similar

import { configureOkendo } from '@okendo/okendo-widgets-vue';

configureOkendo({
    subscriberId: 'your-subscriber-id-here',
    widgetSettings: {
        dateFormat: 'MMM/d/yyyy',
        enableFilters: true,
        defaultReviewsSortOrder: 'rating desc'
    }
});

| widgetSettings | Description |Data Type| Default Value | Accepted Values | |:-----------------|:------------|:--------|:--------------|:----------------| |dateFormat|Date formatting on individual reviews and questions|string|relative| date-fns accetped values |enableFilters|Filter reviews by product attributes|boolean|false|false | true| |defaultReviewsSortOrder|Initial reviews sorting order|string|'date desc'|'date desc' | 'date asc' | 'has_media desc' | 'rating desc' | 'rating asc' | 'helpful desc' | 'unhelpful desc'

5. Import the components you need

import { OkendoStarRating } from '@okendo/okendo-widgets-vue';
import { OkendoReviewsWidget } from '@okendo/okendo-widgets-vue';

export default {
    components: {
        OkendoStarRating,
        OkendoReviewsWidget,
        OkendoQuestionsWidget,
        OkendoCombinedWidget
    }
};

The combined widget displays both the question and review widgets in tabs

6. Include the components in your template, providing the Shopify product ID as a prop

<okendo-star-rating :productId="shopifyProductId" />
<okendo-reviews-widget :productId="shopifyProductId" />
<okendo-questions-widget :productId="shopifyProductId" />
<okendo-combined-widget :productId="shopifyProductId" />

Note: The reviews widget component will show reviews for all products if the productId is omitted