hsds react

HSDS: React

React Components для помощи в системе проектирования скаута

Живая демонстрация

Проверьте сборник рассказов HSDS: https://hsds.helpscout.com/.

Установить

 npm install @helpscout/hsds-react --save

Начиная

После клонирования этого репо, беги:

 npm install

Как только все будет установлено, запустите:

 npm start

Проверьте сборник рассказов HSDS на http: // localhost: 8900/в вашем браузере!

Адаптер SVG

По состоянию на v2.18.0, набор svg является Opt-In. Это было сделано, чтобы уменьшить скомпилированный размер пакета. Чтобы загрузить значки svg , добавьте соответствующий адаптер в ваше приложение.

Рекомендуется загружать адаптер где -то в пределах вашей основной точки входа (например, src/index.js ).

 // src/index.js
// For a lighter-weight svg set for embeddables
import '@helpscout/hsds-react/adapters/embed'
// For the complete svg set
import '@helpscout/hsds-react/adapters/app'

Примечание. Это загружает все изображения svg , включая Icon и Illo .

Тестирование

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

 npm run dev

Чтобы выполнить все тесты (с отчетностью о покрытии), запустите:

 npm run test

Издательский

Объединение PR

Чтобы объединить пиар после завершения релиза, пожалуйста, сделайте сквош и слияние со страницы PR. Это будет держать историю в чистоте в главной ветви

Мы склонны делать релиз только с одним пиаром в то время, если это возможно

Выпуск на NPM

Вы можете узнать больше о выпуске Main или выпуске бета -сборки

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

 npm run release

Вам будет представлен приглашение CLI с опциями. Выберите тот, который вы хотите, и все! Сценарий позаботится об остальном (от тестирования до публикации).

Развертывание сборника рассказов

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

 npm run deploy

Обучение

• Документация HSDS: https://hsds.helpscout.com/
• Глубокая документация разработчика: Dev Docs
• Кроме того, посмотрите наши видео для получения дополнительных учебных ресурсов

Синий?

8 ноября 2018 года мы переименованы в синий цвет на HSDS: React?

Оригинальная синяя библиотека по -прежнему будет существовать на NPM и все еще будет установлена через:

 npm install @helpscout/blue --save

Тем не менее, продолжение разработки этой библиотеки компонентов будет продолжаться в соответствии с HSDS: React, который можно установить через:

 npm install @helpscout/hsds-react --save

Большое спасибо всем людям, вовлеченным в синий! Синий всегда будет вашим мальчиком? Полем