rocket ui

? Desapercibido

Esta biblioteca ha sido desaprobada. Los componentes se han re-muuidos utilizando las últimas versiones de Materi-Ui y React y se pueden encontrar aquí: Rocket-UI

Para documentación y ejemplos significativos, consulte la documentación de Gitbook

---

Rocket-ui (en desuso)

Colección de bits

Un conjunto de componentes React reutilizables y compuestos construidos sobre el núcleo de la interfaz de usuario del material para desarrollar interfaces de aplicaciones web rápidas y amigables.

? ‍ Verifique la guía de migración de Bit Legacy a la versión Bit Harmony.

? Instalación

NPMRC es el archivo de configuración NPM y para usar nuestra biblioteca, debe configurar este archivo.

‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼‼ El archivo .npmrc ya está configurado

Correr

npm config set @totalsoft_oss:registry https://node.bit.cloud

Este comando agregará una entrada en su archivo root .npmrc. Si no existe, creará uno.

- Instalación de un componente

Vaya a la página principal del componente y luego seleccione el comando para el administrador de paquetes que usa. También puede elegir la versión que desea instalar.

¡Ejecute el comando en su terminal y estará listo para usarlo!

npm i @totalsoft_oss/rocket-ui.components.data-display.typography

- Instale todos los componentes con un solo paquete

Si desea tener todos los componentes de su proyecto en un solo paquete. Navegue al componente central en la nube de bits.

Instalar el paquete core ejecutando

npm i @totalsoft_oss/rocket-ui.core

Uso

    import React from 'react'
    import Typography from '@totalsoft_oss/rocket-ui.components.data-display.typography'
    /* example using core package
    import { Typography } from '@totalsoft_oss/rocket-ui.core'
    */

    const App = ( ) => {
        return (
            < Typography variant = 'body2' emphasis = 'bold' >
                "Text"
            </ Typography >
        )
    } 

? Estructura de componentes

Cada componente está en una sección apropiada para su propósito. Por ejemplo, todos los componentes relacionados con los botones residen en la carpeta buttons . Todos los componentes tienen la misma estructura de archivos. Implementamos y aplicamos esta estructura creando nuestro propio generador de componentes, una funcionalidad proporcionada por bit. Como verá, todos los componentes y los que se crearán utilizando la plantilla rocket-generator tendrán la siguiente estructura

• archivo de entrada index.js .
• MyComponent.js Archivo principal.
• MyComponent.test.js Test File.
• MyComponent.docs.mdx Docs File para el componente.
• Carpeta de composiciones de compositions .
  • MyComponent.composition.js Compositions para simular el componente en diferentes estados y contextos.

? Guía contribuyente

Usamos bit para la gestión y contribución de los componentes. BIT es una herramienta de código abierto para componer software basado en componentes.

- Instalar bit

Se recomienda usar el símbolo del sistema en lugar de PowerShell debido a algunos problemas de compatibilidad.

npm i -g @teambit/bvm

bvm install

Si se produce algún error en la instalación, verifique la sección de solución de problemas.

- Inicie el servidor local

Después de que el bit se instale con éxito, puede clonar el repositorio y usar funcionalidades de bit al máximo.

Para comenzar de inmediato, ejecute bit start del símbolo del sistema y abra Localhost: 3000. Puede tomar un tiempo construir la primera vez que ejecuta este comando, ya que está construyendo toda la interfaz de usuario para su entorno de desarrollo. Cuando el servidor local está en funcionamiento, vería todos los componentes y puede interactuar con ellos.

bit start

- Modificar los componentes existentes

Después de cambiar/arreglar el componente de acuerdo con sus necesidades, debe ejecutar bit test para asegurarse de que todas las pruebas pasen y agregue más si sus cambios requieren.

bit test

Además, si se agrega una nueva característica, además de las pruebas, también se debe agregar un ejemplo con la nueva funcionalidad. Los archivos de ejemplos se encuentran en cada directorio de componentes dentro del directorio compositions .

Después de cambiar el componente, debe ejecutar bit status para verificar los problemas relacionados con los bits y luego bit compile para tener las últimas modificaciones en su interfaz de usuario.

bit status

bit compile

- Agregar un nuevo componente

Para crear un nuevo componente, debe usar nuestro propio generador de componentes, rocket-generator , que proporciona una plantilla que es útil para implementar un nuevo componente.

bit create rocket-generator components/buttons/my-component

- Solicitud de extracción abierta

Cuando se realiza su cambio/característica/fijación y desea marcar qué componentes se publican, su próxima versión y una opción de uso de mensajes de ChangeLog.

bit tag -m " my message " --soft

Después de ejecutar el comando anterior, debería ver el archivo bitmap cambiado y después de eso puede crear su solicitud de extracción.

Puede leer más sobre bit y otras funcionalidades que él proporciona aquí.

Licencia

Rocket-UI tiene licencia bajo la licencia MIT. @TotalSoft