Nuanced Pumpkin Mavens

    @eduzz/nps-react
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.5 • Public • Published

    Eduzz NPS React

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

    Instalação 🔧

    npm install @eduzz/nps-react
    yarn add @eduzz/nps-react

    Como usar? 🤠

    import Nps from '@eduzz/nps-react';
    
    <Nps 
      params={{
        key_fields: {
          app: ['eduzz'],
          user_id: 123
        },
        tags: {
          application: 'orbita',
          id: 123,
          email: 'email@example.com',
          name: 'Michael Jackson'
        }
      }} 
    />

    API ☁️

    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 💻

    Para rodar o projeto localmente é bem simples:

    // para instalar as dependências
    yarn
    
    // inicia o storybook
    yarn dev

    Keywords

    none

    Install

    npm i @eduzz/nps-react

    DownloadsWeekly Downloads

    76

    Version

    0.1.5

    License

    none

    Unpacked Size

    103 kB

    Total Files

    8

    Last publish

    Collaborators

    • matheuseduzz
    • miguelaugl
    • saulo.castilhos
    • danieloprado
    • jonathasprodrigues
    • caferrari
    • feermooraes