kubit react components

---

Empezando

Instalación

Para instalar el paquete, ejecute el siguiente comando:

npm

npm install @kubit-ui-web/react-components

hilo

yarn add @kubit-ui-web/react-components

Esto instalará el paquete y sus dependencias. Ahora puede importar los componentes y usarlos en su aplicación.

Uso

Para usar los componentes, importarlos del paquete y úselos en su aplicación.

 import { Button , KubitProvider } from '@kubit-ui-web/react-components' ;
import React from 'react' ;

const App = ( ) => {
  return (
    < KubitProvider >
      < Button variant = "PRIMARY" size = "MEDIUM" >
        Click me
      </ Button >
    </ KubitProvider >
  ) ;
} ;

export default App ;

Esto representará el botón con los estilos y la funcionalidad predeterminados.

Nota: Se requiere el KubitProvider para usar los componentes. Proporciona el tema y otro contexto a los componentes.

Puede enviar más información sobre el cambio del tema y otras opciones en el tema personalizar

Documentación

Puede encontrar la documentación de los componentes web en el sitio web de Kubit UI

Libro de cuentos

Para ejecutar el libro de cuentos, en primer lugar clona el repositorio e instale las dependencias. Luego ejecute el siguiente comando:

npm run storybook

yarn storybook

Esto iniciará el servidor de libros de cuentos y puede ver los componentes en acción.

Pruebas

Para ejecutar las pruebas, puede usar el siguiente comando:

npm run test

yarn test

Esto ejecutará las pruebas y mostrará los resultados en la terminal.

Que contribuye

Estamos abiertos a contribuciones. Si desea contribuir al proyecto, siga los pasos a continuación:

1. Bifurca el repositorio : haga clic en el botón "Bifurca" en la esquina superior derecha de la página del repositorio en GitHub. Esto creará una copia del repositorio en su cuenta.

2. Clone El repositorio : use git clone para clonar el repositorio de su máquina local.

   git clone

3. Cree una rama : use git checkout para crear una nueva rama para sus cambios.

   git checkout -b < branch-name >

4. Haga cambios : realice los cambios necesarios en la base de código. Y probar los cambios.

5. Cambios de confirmación : use git commit para confirmar sus cambios en la rama.

   git commit -m " Your commit message "

6. Cambios de empuje : use git push para empujar sus cambios a su repositorio bifurcado.

   git push origin < branch-name >

7. Abra una solicitud de extracción : vaya al repositorio original en GitHub y haga clic en el botón "nueva solicitud de extracción". Complete el formulario con detalles sobre sus cambios y envíe la solicitud de extracción.

Una vez que se haya enviado su solicitud de extracción, un mantenedor revisará sus cambios y proporcionará comentarios. Si todo se ve bien, su solicitud de extracción se fusionará y sus cambios se convertirán en parte del proyecto.

Para obtener más información sobre cómo contribuir a nuestros proyectos, consulte el archivo CONTRIBUTING.md .