rocket ui

? Descontinuado

Esta biblioteca foi preterida. Os componentes foram renomeados usando as mais recentes versões Materi-Ui e React e podem ser encontradas aqui: Rocket-Ui

Para documentação e exemplos significativos, consulte a documentação do GitBook

---

Rocket-Ui (depreciado)

Coleção de bits

Um conjunto de componentes react reutilizáveis e composíveis, construídos sobre o núcleo da interface do usuário do material para o desenvolvimento de interfaces de aplicativos da Web rápidos e amigáveis.

? ‍ Verifique o guia de migração do bit legado para a versão bit harmony.

? Instalação

O NPMRC é o arquivo de configuração do NPM e, para usar nossa biblioteca, você precisa configurar esse arquivo.

‼ Pule esta etapa se o projeto for gerado com o nosso gerador de foguetes do WebApp. O arquivo .npmrc já está configurado

Correr

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

Este comando adicionará uma entrada no seu arquivo root .npmrc. Se não existir, criará um.

- Instalando um componente

Vá para a página principal do componente e selecione o comando para o gerenciador de pacotes que você usa. Você também pode escolher a versão que deseja instalar.

Execute o comando no seu terminal e você estará pronto para usá -lo!

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

- Instale todos os componentes com um único pacote

Se você deseja ter todos os componentes do seu projeto em apenas um pacote. Navegue até o componente principal na nuvem de bits.

Instale o pacote core executando

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 >
        )
    } 

? Estrutura de componentes

Cada componente está em uma seção apropriada para sua finalidade. Por exemplo, todos os componentes relacionados aos botões residem na pasta buttons . Todos os componentes têm a mesma estrutura de arquivos. Implementamos e aplicamos essa estrutura criando nosso próprio gerador de componentes, uma funcionalidade fornecida por pouco. Como você verá, todos os componentes e os que serão criados usando o modelo de rocket-generator terão a seguinte estrutura

• index.js Arquivo de entrada.
• MyComponent.js Arquivo principal.
• MyComponent.test.js Arquivo de teste.
• MyComponent.docs.mdx Docs arquivo para o componente.
• Pasta de compositions composições.
  • MyComponent.composition.js Composições para simular o componente em diferentes estados e contextos.

? Guia contribuinte

Usamos o bit para gerenciamento e contribuição dos componentes. O Bit é uma ferramenta de código aberto para compor software orientado a componentes.

- Instale o bit

Recomenda -se usar o prompt de comando em vez de PowerShell devido a alguns problemas de compatibilidade.

npm i -g @teambit/bvm

bvm install

Se ocorrer algum erro na instalação, verifique a seção Solução de problemas.

- Inicie o servidor local

Depois que o bit é instalado com sucesso, você pode clonar o repositório e usar funcionalidades de bits no máximo.

Para começar imediatamente a execução no comando prompt bit start e abre localhost: 3000. Pode demorar um pouco para construir a primeira vez que você executa este comando, pois está construindo toda a interface do usuário para o seu ambiente de desenvolvimento. Quando o servidor local está em funcionamento, você verá todos os componentes e pode interagir com eles.

bit start

- Modificar componentes existentes

Depois de alterar/corrigir o componente de acordo com suas necessidades, você deve executar bit test para garantir que todos os testes estejam passando e adicione mais se suas alterações exigirem.

bit test

Além disso, se um novo recurso for adicionado, além dos testes, um exemplo com a nova funcionalidade também deve ser adicionado. Os arquivos de exemplos estão em cada diretório de componentes no diretório compositions .

Depois de alterar o componente, você precisa executar bit status para verificar problemas relacionados a bits e depois bit compile para ter as mais recentes modificações em sua interface do usuário.

bit status

bit compile

- Adicionando um novo componente

Para criar um novo componente, você deve usar nosso próprio gerador de componentes, rocket-generator , que fornece um modelo que é útil na implementação de um novo componente.

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

- Solicitação de tração aberta

Quando sua alteração/recurso/correção é concluída e você deseja marcar quais componentes são publicados, a próxima versão e uma opção de uso da mensagem Changelog -Soft.

bit tag -m " my message " --soft

Depois de executar o comando acima, você verá o arquivo bitmap alterado e depois disso pode criar sua solicitação de tração.

Você pode ler mais sobre bits e outros funcionalititos que ele fornece aqui.

Licença

Rocket-UI é licenciado sob a licença do MIT. @Totalsoft