Eduzz NPS React

Componente React para realizar o NPS (Net Promoter Score) da Eduzz.

Instalação :wrench:

npm install @eduzz/nps-react

yarn add @eduzz/nps-react

Como usar? :cowboy_hat_face:

import Nps from '@eduzz/nps-react';

<Nps 
  params={{
    key_fields: {
      app: ['eduzz'],
      user_id: 123
    },
    tags: {
      application: 'orbita',
      id: 123,
      email: '[email protected]',
      name: 'Michael Jackson'
    }
  }} 
/>

API :cloud:

Props

type Apps = 'eduzz' | 'sun' | 'alumy' | 'backoffice' | 'telescope' | 'jobzz' | 'orbita' | 'nutror' | 'blinket';

type SetupParams = {
  key_fields: {
    app: [Apps];
    user_id: number;
  };
  tags?: Record<any, any>;
  /**
   * Defaults to 'https://nps.eduzz.com' 
   */
  endpoint?: string;
}

Desenvolvendo :computer:

Para rodar o projeto localmente é bem simples:

// para instalar as dependências
yarn

// inicia o storybook
yarn dev