kubit react components

---

Начиная

Установка

Чтобы установить пакет, запустите следующую команду:

npm

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

пряжа

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

Это установит пакет и его зависимости. Теперь вы можете импортировать компоненты и использовать их в своем приложении.

Использование

Чтобы использовать компоненты, импортируйте их из пакета и используйте их в вашем приложении.

 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 ;

Это сделает кнопку с помощью стилей и функциональности по умолчанию.

Примечание: KubitProvider должен использовать компоненты. Это обеспечивает тему и другой контекст компонентам.

Вы можете предоставить больше информации о изменении темы и других вариантов в теме «Настройка»

Документация

Вы можете найти документацию для веб -компонентов на веб -сайте UI Kubit

Сборник рассказов

Чтобы запустить сборник рассказов, клонировать репозиторий и установить зависимости. Затем запустите следующую команду:

npm run storybook

yarn storybook

Это запустит сервер рассказов, и вы сможете увидеть компоненты в действии.

Тесты

Чтобы запустить тесты, вы можете использовать следующую команду:

npm run test

yarn test

Это запустит тесты и покажет результаты в терминале.

Внося

Мы открыты для вкладов. Если вы хотите внести свой вклад в проект, пожалуйста, выполните следующие шаги:

1. Вилка репозитория : нажмите кнопку «Вилка» в верхнем правом углу страницы репозитория на GitHub. Это создаст копию репозитория в вашей учетной записи.

2. Клонировать репозиторий : используйте git clone , чтобы клонировать репозиторий на местную машину.

   git clone

3. Создайте филиал : используйте git checkout , чтобы создать новую ветку для ваших изменений.

   git checkout -b < branch-name >

4. Внесите изменения : внесите необходимые изменения в кодовую базу. И проверить изменения.

5. Комплект изменений : используйте git commit , чтобы совершить свои изменения в филиале.

   git commit -m " Your commit message "

6. Изменения толкания : используйте git push , чтобы подтолкнуть ваши изменения в раздвоенный репозиторий.

   git push origin < branch-name >

7. Откройте запрос на привлечение : перейдите в исходный репозиторий на GitHub и нажмите кнопку «Новый запрос на развлечение». Заполните форму подробностями о ваших изменениях и отправьте запрос на вытягивание.

После того, как ваш запрос на привлечение будет представлен, содействие будет рассмотреть ваши изменения и предоставить обратную связь. Если все выглядит хорошо, ваш запрос на тягу будет объединен, и ваши изменения станут частью проекта.

Для получения дополнительной информации о внесении вклад в наши проекты, пожалуйста, обратитесь к файлу CONTRIBUTING.md .