Skip to content

gigit-ai/gigit-apps-sample

Repository files navigation

Gigit Apps

Gigit Apps is a collection of React components designed to enhance your e-commerce store experience. The package includes QAWidget, Highlights, and SmartMenu components, each requiring minimal configuration to integrate seamlessly with your store.

Installation

npm install @gigit-ai/gigit-apps --//registry.npmjs.org/:_authToken=YOUR_ACCESS_TOKEN

For using an NPM access token in a CI/CD workflow, refer to the official documentation: Using private packages in a CI/CD workflow.

Components

1. QAWidget

A widget that enables chat with AI to answer common questions on your store.

Usage

import { QAWidget } from '@gigit-ai/gigit-apps'

const MyComponent = () => (
    <QAWidget shop="my-shop.com" productTitle="My Product" />
)

For NextJS Pages Router, you may need to dynamically import the components.

import dynamic from 'next/dynamic'
const QAWidget = dynamic(
    () => import('@gigit-ai/gigit-apps').then((module) => module.QAWidget),
    {
        ssr: false,
    }
)

Props

Prop Type Required Description
shop string The domain of your store URL (e.g., my-shop.com).
productTitle string Optional The name of the product. Required if used on a product page.
productId string Optional The id of the product. Required if used on a product page.
test bool Optional If set to true, interactions with this widget will not be included in analytics.

2. Highlights

A component that showcases key product features relevant to users browsing the page. This should be used on a product page.

Usage

import { Highlights } from '@gigit-ai/gigit-apps'

const MyComponent = () => (
    <Highlights shop="my-shop.com" productTitle="My Product" />
)

Props

Prop Type Required Description
shop string The domain of your store URL (e.g., my-shop.com).
productTitle string The name of the product.
test bool Optional If set to true, interactions with this widget will not be included in analytics.

3. SmartMenu

A navigation menu that improves user experience.

Usage

import { SmartMenu } from '@gigit-ai/gigit-apps'

const MyComponent = () => <SmartMenu shop="my-shop.com" />

Props

Prop Type Required Description
shop string The domain of your store URL (e.g., my-shop.com).
test bool Optional If set to true, interactions with this widget will not be included in analytics.

License

This is a private library. Unauthorized distribution or modification is prohibited.

Support

For issues or feature requests, please email us at [email protected].

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published