Avada Components

A collection of React components built with Shopify Polaris for company-wide app usage.

Installation

# Using yarn
yarn add avada-components

# Using npm
npm install avada-components

Components

SeoScore

A component for displaying SEO performance metrics and issues for a Shopify store.

import { SeoScore } from 'avada-components';

function App() {
  return (
    <SeoScore
      type="widget" // or "banner"
      shop={{
        shopifyDomain: 'my-store.myshopify.com',
        // other shop properties...
      }}
    />
  );
}

Props

| Prop | Type | Required | Default | Description | | ---- | ---------------------- | -------- | ---------- | ------------------------------ | | type | 'widget' \| 'banner' | No | 'widget' | Display style of the SEO score | | shop | Shop | Yes | - | Shop information object |

TypeScript Support

This package is written in TypeScript and includes type definitions. You'll get full type support when using the components:

import { SeoScore, type SeoScoreProps } from 'avada-components';

// Props will be type-checked
const props: SeoScoreProps = {
  type: 'widget',
};

function App() {
  return <SeoScore {...props} />;
}

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

ISC