Изображение обложки Виктора Р. Руиса на Flickr
Часто я меняю вещи или Обновите библиотеки, которые я использую, и все работает, но они больше не выглядят красиво.
Например, я обновил React-Cnative-SVG и они переименовали Вращать Опора в ротация И, по сути, слайдер больше не был повернут на 90 °. Это все еще сработало, но выглядело странно.
Поэтому я подумал, что мне нужен способ быстро найти эти проблемы. Автоматически тоже было бы неплохо, но первый шаг должен позволить мне увидеть эти проблемы без необходимости щелкнуть все приложение.
Введите сборник рассказов
Сборник рассказов продается как среда разработки для компонентов пользовательского интерфейса Анкет
какая
Сказко -сборник позволяет отображать ваши компоненты в разных штатах в своем собственном пользовательском интерфейсе , компонентный каталог. Это позволяет вашему ранее Просмотрите все компоненты быстро Например, когда вы думаете о написании нового, чтобы увидеть, есть ли у вас что -то, что сделало бы работу, или если вы хотите проверить, сломались ли некоторые после обновления.
Поскольку компоненты отображаются за пределами вашего приложения Это также должно привести к лучшей архитектуре компонентов , потому что они должны быть по-настоящему отделенными.
Как
Сначала вы добавляете его в свой проект. Для этого вы Установите CLI Это устанавливает все зависимости и создает некоторые файлы, которые вы используете позже:
$ npm i -g @storybook/cli $ cd your-project $ getstorybook
GetStoryBook Командовые выясняют, какой проект у вас есть, и пытается установить для него, предварительно настроенный. Я создал приложение React с Create-React-App Анкет
После этого у вас есть Новые сценарии в вашем package.json
сборник рассказовиспользуется для разработкиBuild Storybookиспользуется для создания статической сборки каталога
У вас также есть новый каталог под названием истории , в моем Create-React-App Случай был создан внутри Your-Project/SRC
Теперь вы можете написать истории Для ваших компонентов, которые похожи на тесты, которые вы знаете из единичного тестирования.
Давайте попробуем простой пример, я хочу <Текст> Компонент, который позволяет мне установить его Текстовое декорация к подчеркнуть через логическую опору.
// src/Text.js
import React from "react";
export default ({ children, underline }) => (
{children}
);
Теперь я пытаюсь отображать этот компонент в сборнике рассказов с двумя государствами реквизита. Для этого я импорт Текст компонент в src/stories/index.js и использовать сборники рассказов Истории () функция
// src/stories/index.js
import React from "react";
import { storiesOf } from "@storybook/react";
import Text from "../Text";
storiesOf("Text", module)
.add("without underline", () => Hello, world! )
.add("with underline", () => Hello, world! );
Теперь я могу проверить, работало ли все, запустив сборник рассказов Скрипт и открытие браузера в http://localhost: 9009
$ yarn run storybook
С левой стороны вы можете увидеть навигацию деревьев. Каждый призыв к Истории () Функция создала раскрывающееся срок со ссылками на рассказы, добавленные через add () метод
Теперь я могу нажать вокруг этого каталога, чтобы посмотреть на различные состояния моего Текст составная часть.
Вывод
Справочник-интересный подход к фронтальной разработке. Он позволяет создавать и проверять ваши компоненты в изоляции, поэтому вы можете сосредоточиться на одной проблеме за раз. Пользовательский интерфейс каталога позволяет вам быстро просматривать компоненты и проверять, работают ли они после того, как вы что -то изменили в своем приложении.
Оригинал: “https://dev.to/kayis/streamline-your-front-end-development-with-storybook–4m22”