Рубрики
Без рубрики

Что такое историй и как я могу использовать его для создания библиотеки компонентов в реакции?

Франки, такие как React, Vue и Angular, все помогают разработчикам создают модульные системы с использованием компонентов, но обычно не включают в себя хороший способ увидеть их всех с более высокой точки зрения. Итак, как мы можем использовать SaleBook для создания библиотек и систем дизайна, которые самообслуживают, когда мы их создаем?

Автор оригинала: FreeCodeCamp Community Member.

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

Итак, как мы можем использовать SaleBook для создания библиотек и систем дизайна, которые самообслуживают, когда мы их создаем?

  • Что такое история книги?
  • Что мы собираемся построить?
  • Шаг 0: загрузка приложения
  • Шаг 1: Установка сюжетной книги
  • Шаг 2: Создание новой кнопки
  • Шаг 3: Использование нашего нового компонента кнопки
  • Повторите: создание нового компонента заголовка
  • Больше характеристик рассказов книги

Что такое история книги?

Статьгор Является ли инструмент JavaScript, который позволяет разработчикам создавать организованные системы интерфейса пользовательских интерфейсов, создающих как в процессе строительства, так и для документации более эффективным и проще в использовании.

После того, как вы построите компонент, StoralBook позволяет создавать файл «Story», в котором вы можете затем импортировать свой компонент и создавать различные примеры корпуса использования в песочнице IFRAMED, используя этот компонент.

Это обеспечивает организованную и сфокусированную среду для создания новых компонентов и работы по существующим.

Что мы собираемся построить?

Мы собираемся загрузить новую Реагировать js Приложение, использующее Создать ract app Отказ

Внутри этого приложения мы собираемся установить Designbook и создать несколько новых компонентов, которые помогут нам узнать, как создавать новые компоненты, которые мы можем работать в истории, а затем использовать его в приложении React.

Шаг 0: загрузка приложения

Чтобы начать, мы собираемся начать с нуля с Создать ract app Отказ Это поможет нам сосредоточиться на том, чтобы получить продуктивную книгу в сборной книге, а не пройти через интегрировать его в текущее приложение.

Это сказано, что если вы уже работаете с приложением, созданным, созданным с использованием приложения Create React, которое не выбрасывается, вы должны быть в состоянии все еще выполнить с частью 1 и за пределы то же самое!

Итак, давайте начнем при навигации, где мы хотим создать наше новое приложение и запустить команду create app app:

npx create-react-app my-storybook

Примечание: не стесняйтесь заменить My-Storybook С названием каталога по вашему выбору.

Как только это закончится, вы можете перейти к каталогу:

cd my-storybook

И мы готовы пойти!

Шаг 1: Установка сюжетной книги

Статья книги, к счастью, действительно легко начать работать со стандартной установкой реагирования. Особенно при создании приложения React DeliouseBook автоматически обнаруживает, что мы используем приложение, созданное с помощью CRA, и устанавливает зависимости и эрмальки для нас.

Инициализация сюжетной книги

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

npx -p @storybook/cli sb init

Если вы не используете создание приложения RACT или не работали, вы можете проверить их Доступные гиды в своих документах Отказ

После этого следует установить все наши зависимыми источника книги.

Запуск истории книги

Так что теперь мы готовы двигаться! Наконец, беги:

yarn storybook
# or
npm run storybook

И как только все заканчивает загрузку, STEALBOOK откроет новую вкладку в вашем браузере, и теперь вы должны увидеть приветственное сообщение внутри вашего нового Dashboard StoreBook!

Следуйте вместе с Commit!

Шаг 2: Создание новой кнопки

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

Вы также должны заметить, если вы нажмете кнопку, вы на самом деле увидите распечатать действие внутри вкладки Действия внизу. Это показывает событие, которое захвачено из кнопки, нажмите.

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

Создание нового компонента кнопки

Чтобы начать, давайте сначала создадим несколько каталогов:

  • Под SRC Создайте новую папку под названием составные части
  • Под Компоненты Создайте новую папку под названием Кнопка

Как только вы создадите эти папки, создайте новый файл под названием index.js внутри вашего SRC/Компоненты/Кнопка Папка и внутри Добавить:

// Inside src/components/Button/index.js

export { default } from './Button';

Это импортирует следующий файл, который мы создали под названием Button.js Что позволит нам легче импортировать наши файлы с SRC/Компоненты/Кнопка вместо /SRC/Компоненты/Кнопка/Кнопка Отказ

Далее давайте создадим Button.js прямо рядом с нашим index.js Файл со следующим контентом:

// Inside src/components/Button/Button.js

import React from 'react';

const Button = ({ children, ...rest }) => {
  return (
    
  )
}

export default Button;

Здесь мы создаем новый компонент называемый кнопкой, который добавляет класс кнопка к элементу и проходит через дети Отказ Мы дополнительно Разрушение остальные реквизиты в Отдых Переменная и Распространение Это значение в <кнопка> элемент.

Если вы следите, ваши файлы теперь должны выглядеть так:

Использование нашего нового компонента кнопки

Так что теперь, когда у нас есть наш компонент кнопки, давайте использовать его!

Откройте файл SRC/Stories/1-кнопка .story.js и заменить линию, которая импортирует Кнопка с участием:

И как только вы нажмите «Сохранить», вы можете открыть резервную вкладку «Ваш браузер» с помощью Dashboard WallBook, и теперь вы можете увидеть кнопку, которая выглядит в основном подобной, но она использует стили по умолчанию Browser для <кнопка> элемент. Вы даже заметите, что если вы нажмете его, событие все равно будет войти в вкладку «Действия».

Стайлинг наша кнопка компонента

Наконец, мы, вероятно, не хотим использовать стили по умолчанию браузера, поэтому давайте посмотрим, хорошо.

В нашем SRC/Компоненты/Кнопка Справочник, добавить новый файл Button.css и добавьте следующий контент:

/* Inside src/components/Button/Button.css */

.button {
  color: white;
  font-weight: bold;
  background-color: blueviolet;
  border: none;
  padding: .8em 1em;
  border-radius: .2rem;
}

Это применяет несколько стилей для нашего .button Класс, как добавление цвета фона и изменение цвета шрифта в белый цвет.

Но если вы откроете сборник книги, вы заметите, что это ничего не сделало. Чтобы использовать его, нам нужно импортировать его в наш компонент.

Внутри SRC/Компоненты/Кнопка/Button.js Добавьте следующее сверху под Import React:

import './Button.css';

И как только вы сохраните это и откроете свой браузер, теперь вы должны увидеть нашу новую кнопку с нашими обновленными стилями!

Следуйте вместе с Commit!

Шаг 3: Использование нашего нового компонента кнопки

Конечная цель нашего компонента – использовать его правильно? Так что давайте добавим его в наше приложение.

Переключение в приложение React

Сначала нам понадобится либо запустить наше приложение React на вкладке «Новый терминал», либо убить процесс «Статью» и начать процесс реагирования. Чтобы запустить приложение React с помощью приложения CREATE RACT, запустите:

yarn start
# or
npm run start

После этого нагрузки мы должны иметь наше стандартное приложение Create React, если вы следуете вместе со мной:

Импорт и использование новой кнопки

Далее, внутри SRC/App.js Давайте импортируем нашу новую кнопку в верхней части страницы:

import Button from './components/Button';

С помощью кнопки Imported мы можем его использовать. Здесь мы можем просто добавить его нигде, где мы хотим на странице. Я собираюсь заменить преобразование Enternal React с:

И если мы сохраним и перезагрузим страницу, мы теперь должны увидеть нашу кнопку на странице!

Следовать вместе с фиксацией

Повторите: создание нового компонента заголовка

Великая вещь о сборе книги и реагирования (или любой из поддерживаемых рамок) заключается в том, что этот процесс масштабируется как можно больше компонентов, сколько вы хотите.

Итак, давайте построим другой компонент!

Создание нашего заголовочного компонента

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

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

Давайте начнем, вращаясь назад на нашем сервере с рассказами с:

yarn storybook
# or 
npm run storybook

Создать Заголовок каталог внутри SRC/Компоненты каталог.

Создать index.js Файл внутри SRC/Компоненты/заголовок Со следующим контентом:

// In src/components/Header/index.js

export { default } from './Header';

Создать Header.js Файл внутри SRC/Компоненты/заголовок Со следующим контентом:

// In src/components/Header/Header.js

import React from 'react';
import './Header.css';

const Header = ({ children }) => {
  return (
    

      { children }
    

  )
}

export default Header;

Создать Header.css Файл внутри SRC/Компоненты/заголовок Со следующим контентом:

/* In src/components/Header/Header.css */

.header {
  font-family: sans-serif;
  font-size: 2.5em;
  color: blueviolet;
  border-bottom: solid 5px aqua;
  padding-bottom: .2em;
  box-shadow: 0 5px 0 blueviolet;
}

Теперь, если вы заметите, если вы попытаетесь открыть историю книги, опять же, ничего не произойдет. На этот раз нам нужно создать новый файл истории.

Создание нового файла истории

Внутри SRC/Stories Добавьте новый файл под названием 2-header.story.js :

// Inside src/stories/2-Header.stories.js

import React from 'react';

import Header from '../components/Header';

export default {
  title: 'Header',
  component: Header,
};

export const Text = () => 
Hello Header
;

Вот разбивка нашего файла истории:

  • Во-первых, мы импортируем наш компонент – это довольно стандартное время, которое мы хотим использовать его
  • Первое, что мы экспортируем, это по умолчанию объект. С рассказами, он ожидает, что экспорт по умолчанию будет конфигурация нашей истории, поэтому здесь мы предоставляем его названием, и мы проходим в компоненте, который мы используем для этой истории
  • Второе и последнее, что мы экспортируем, это Текст постоянный. С помощью StoreBook любой экспорт не по умолчанию будет рассмотрен вариант, который будет вложен в заголовке, который вы предоставляете в экспорт по умолчанию

И если вы сохраните этот файл и откройте панель инструментов DaseBook в браузере, теперь вы должны увидеть новый заголовок!

Использование компонента заголовка

Использование нашего компонента точно так же, как наша кнопка компонента, поэтому внутри SRC/App.js Давайте добавим наш заголовок.

После запуска вашего сервера RACT, сначала импортируйте наш новый заголовок:

// In src/App.js

import Header from './components/Header';

Затем добавьте его в верхнюю часть страницы:

// In src/App.js


My App

И если вы откроете страницу, мы увидим наш новый заголовок!

Следуйте вместе с Commit!

Добавление больше компонентов

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

Теперь вы можете использовать это, чтобы управлять своей библиотекой компонентов и лучше поддерживать всю систему для вашего проекта!

Больше характеристик рассказов книги

Статья книги не останавливается только с добавлением компонентов, он обеспечивает возможность настроить Аддоны Это усиливает основные возможности, открывающие много возможностей.

Вот некоторые из моих любимых…

Источник истории

При создании компонентной системы надежда заключается в том, что люди могут легко использовать эти компоненты. Но если у вас нет документации, кому-то должен будет открыть файл или попытаться найти другой пример использования.

Вместо этого Источник истории Показывает источник кода файла Story, который вы создали, позволяя кому-то просматривать панель инструментов «Сборник», чтобы получить пример прямо вместе с выходом компонентов!

Свидетельство

Если вы фанат автоматизированного тестирования, вы, возможно, слышали об использовании Jest Или другой инструмент для добавления тестирования снимков в ваше приложение.

Distoryshots Является ли способ легко добавить честное тестирование шума на вашу компонентную систему. Он создает снимки на основе историй, которые вы создаете, чтобы убедиться, что ваши компоненты не изменяются (или ломаются) во время разработки.

Какая ваша любимая часть истории книги?

Поделись со мной в Twitter!

Продолжить разговор!

Отказ @storybookjs Является ли Audome Tool для управления библиотекой компонентов для системы проектирования вашего проекта? Это делает удовольствие создавать и обновлять компоненты в фокусированной связи? Я прохожу через то, что такое история книги и как начать? #webdev # 100Дасофкод https://t.co/4tlflmp4df.

Читайте ещё по теме: