Автор выбрал Creative Commons для получения пожертвования в рамках программы Write for DOnations.
В этом руководстве вы создадите пользовательские компоненты, передавая свойства в ваш компонент. Свойства — это аргументы, которые вы предоставляете элементу JSX. Они выглядят как стандартные HTML-свойства, но не являются предопределенными и могут использовать несколько типов данных JavaScript, включая числа, строки, функции, массивы и даже другие компоненты React. Ваши пользовательские компоненты могут использовать свойства для отображения данных или использования этих данных, чтобы сделать компоненты интерактивным. Свойства — это ключ к созданию компонентов, которые можно легко адаптировать под разные ситуации, а их знание даст вам инструменты для разработки пользовательских компонентов, которые могут обрабатывать уникальные ситуации.
После добавления свойств в ваш компонент вы будете использовать PropTypes
для определения типа данных, которые ожидает компонент. PropTypes
— это простая система типов для проверки того, что данные соответствуют ожидаемым типам во время исполнения. Они будут использоваться как в качестве документации, так и в качестве механизма проверки ошибок, который позволит сохранить прогнозируемое поведение вашего приложения по мере его масштабирования.
К концу этого руководства вы сможете использовать разные свойства
для создания небольшого приложения, которое будет использовать массив данных о животных и отображать информацию, включая имя, научное наименование, размер, питание и дополнительную информацию.
Примечание. В качестве первого шага необходимо настроить пустой проект, на основе которого вы будете выполнять упражнение из руководства. Если у вас уже есть рабочий проект и вы хотите напрямую работать со свойствами, начните выполнение руководства с шага 2.
Вам потребуется среда разработки для Node.js. Данный обучающий модуль был протестирован с версией Node.js 10.20.1 и версией npm 6.14.4. Чтобы установить его в macOS или Ubuntu 18.04, следуйте указаниям руководства Установка Node.js и создание локальной среды разработки в macOS или раздела Установка с помощью PPA руководства Установка Node.js в Ubuntu 18.04.
В этом руководстве вы будете использовать Create React App. Вы можете найти инструкции по установке приложения с помощью Create React App в статье Настройка проекта React с помощью Create React App. Данное руководство подразумевает знание компонентов React, представление о которых вы можете получить из нашего руководства по созданию пользовательских компонентов в React.
Также вам потребуются базовые знания JavaScript, которые вы можете получить в руководстве Написание кода на JavaScript, а также базовые знания HTML и CSS. Хорошим источником информации о HTML и CSS является сеть разработчиков Mozilla.
На этом шаге мы создадим новый проект, используя Create React App. Затем вы удалите пример проекта и связанные файлы, которые устанавливаются при инициализации проекта. В заключение вы создадите простую структуру файлов для организации ваших компонентов.
Создайте новый проект. В командной строке запустите следующий скрипт для установки нового проекта с помощью create-react-app
:
После завершения создания проекта перейдите в его директорию:
В новой вкладке или окне терминала запустите проект, используя скрипт start Create React App. Браузер будет выполнять автообновление при изменениях, поэтому вы должны оставить этот скрипт работающим все время при работе:
Вы получите запущенный локальный сервер. Если проект не был открыт в браузере, вы можете открыть его, перейдя на страницу http://localhost:3000/
. Если вы запустили приложение на удаленном сервере, воспользуйтесь адресом http://your_IP_address:3000
.
Ваш браузер загрузит простое приложение React в качестве элемента Create React App:
Вы создадите совершенно новый набор пользовательских компонентов. Для начала избавьтесь от шаблонного кода, чтобы получить пустой проект.
Откройте src/App.js
в текстовом редакторе. Это корневой компонент, который встраивается в страницу. Все компоненты будут запускаться отсюда. Дополнительную информацию об App.js
можно найти в статье Настройка проекта React с помощью Create React App.
Откройте src/App.js
с помощью следующей команды:
Вы увидите следующий файл:
Удалите строку import logo from './logo.svg';
. Затем замените весь код оператора return
, который должен возвращать набор пустых тегов: <></>
. В результате вы получите страницу валидации, которая ничего не возвращает. Окончательный код будет выглядеть следующим образом:
Сохраните изменения и закройте текстовый редактор.
В заключение удалите логотип. Вы не будете использовать ее в вашем приложении. Кроме того, вам нужно удалить неиспользуемые файлы, которые не пригодятся вам в работе. Это позволит вам избежать путаницы в будущем.
В окне терминала введите следующую команду:
Если вы откроете ваш браузер, то увидите пустой экран.
Теперь, когда вы успешно очистили пример проекта Create React App, создайте простую структуру файлов. Это позволит вам поддерживать ваши компоненты изолированными и независимыми.
Создайте каталог с именем components
в каталоге src
. В нем будут храниться все ваши пользовательские компоненты.
Каждый компонент будет иметь собственный каталог для хранения файла компонента, а также стилей, изображений, если таковые имеются, и тестов.
Создайте каталог для App
:
Переместите все файлы App
в этот каталог. Используйте подстановочный символ *
для выбора любых файлов, начинающихся с App.
вне зависимости от их расширения. Затем используйте команду mv
для их отправки в новый каталог.
В заключение обновите относительный путь импорта в index.js
, который представляет собой корневой компонент и инициализирует весь процесс.
Оператор импорта должен указывать на файл App.js
в каталоге App
, поэтому необходимо внести следующее изменение:
Сохраните и закройте файл.
Теперь, когда проект настроен, вы можете создать ваш первый компонент.
На этом шаге вы создадите компонент, который будет изменяться на основе передаваемой информации, т.е. свойств. Свойства — это аргументы, которые вы передаете функции или классу, но так как ваши компоненты трансформируются в HTML-объекты с JSX, вы будете передавать свойства в виде HTML-атрибутов. В отличие от HTML-элементов, вы можете передавать множество разных типов данных, от строк до массивов, объектов и даже функций.
Здесь вы создадите компонент, который будет отображать информацию о животных. Этот компонент будет получать имя и научное наименование животного в форме строк, размер в форме целого числа, питание в форме массива строк и дополнительную информацию в форме объекта. Вы будете передавать информацию новому компоненту в форме свойств и использовать эти данные в вашем компоненте.
К концу этого шага у вас будет пользовательский компонент, который будет использовать разные свойства. Также вы сможете повторно использовать компонент для отображения массива данных, используя общий компонент.
Во-первых, вам потребуются шаблонные данные. Создайте файл в каталоге src/App
с именем data.
Откройте новый файл в текстовом редакторе:
Далее добавьте массив объектов, который вы будете использовать в качестве примера данных:
Массив объектов содержит разные данные и дает вам возможность использовать различные свойства. Каждый объект представляет собой отдельное животное с именем, научным наименованием, размером, питанием и опциональным полем дополнительных
данных, которое будет содержать ссылки или заметки. В этом коде вы также экспортировали массив default
.
Сохраните и закройте файл.
Затем создайте временный компонент AnimalCard
. Этот компонент будет получать свойства и отображать данные.
Сначала создайте каталог в src/components
с названием AnimalCard
, а затем
файл с именем src/components/AnimalCard/AnimalCard.js
и CSS-файл с именем src/components/AnimalCard/AnimalCard.css
.
Откройте AnimalCard.js
в текстовом редакторе:
Добавьте базовый компонент, который импортирует CSS и возвращает тег <h2>
.
Сохраните и закройте файл. Теперь вам нужно импортировать данные и компонент в базовый компонент App
.
Откройте src/components/App/App.js
:
Импортируйте данные и компонент, а затем пройдите по данным, возвращая компонент для каждого элемента в массиве:
Сохраните и закройте файл. Здесь вы используете метод массива .map()
для итерации по данным. Кроме добавления цикла у вас также имеется оборачивающий div
с классом, который вы будете использовать для стилей, и тег <h1>
для наименования вашего проекта.
После сохранения данных и перезагрузки браузера вы увидите наименование для каждой карточки.
Далее добавьте несколько стилей для выравнивания элементов. Откройте App.css
:
Замените его содержимое на следующее для организации элементов:
Здесь используется flexbox для приведения в порядок данных и их выравнивания. padding
добавляет некоторое пространство в окне браузера. justify-content
будет обеспечивать дополнительное пространство между элементами, а .wrapper h1
будет размещать заголовок Animal
на всю его длину.
Сохраните и закройте файл. Когда вы сделаете это и обновите браузер, то увидите, что между данными теперь есть определенное свободное пространство.
Теперь, когда у вас есть настроенные компоненты, вы можете добавить свое первое свойство. При итерации по данным у вас был доступ к каждому объекту в массиве data
и элементам, которые он содержит. Вы будете добавлять каждый элемент данных в отдельное свойство, которое затем будет использоваться в компоненте AnimalCard
.
Откройте App.js
:
Добавьте свойство name
в AnimalCard
.
Сохраните и закройте файл. Свойство name
выглядит как стандартный HTML-атрибут, но вместо строки вы передаете свойство name
объекта animal
в фигурных скобках.
Теперь, когда вы передали одно свойство в новый компонент, необходимо использовать его. Откройте AnimalCard.js
:
Все свойства, которые вы передаете в компонент, будут собираться в объект, который будет первым аргументом вашей функции. Выполните деструктуризацию объекта для извлечения отдельных свойств:
Обратите внимание, что вам не нужно деструктурировать свойства для его использования, но это полезный метод для работы с шаблонными данными в этом руководстве.
После деструктурирования объекта вы можете использовать отдельные элементы данных. В данном случае вы будете использовать заголовок в теге <h2>
, включающий значение в фигурных скобках, чтобы React мог использовать его в качестве JavaScript.
Также вы можете использовать свойство в объекте prop
, используя запись через точку. В качестве примера вы можете создать элемент <h2>
следующим образом: <h2>{props.title}</h2>
. Преимущество деструктурирования состоит в том, что вы можете собирать неиспользуемые свойства и использовать оператор rest объекта.
Сохраните и закройте файл. Сделав это и перезагрузив браузер, вы увидите конкретное имя для каждого животного вместо заполнителя.
Свойство name
представляет собой строку, но строка может быть любым типом данных, который вы можете передавать функции JavaScript. Чтобы посмотреть, как это работает, добавьте остальные данные.
Откройте файл App.js
:
Добавьте свойство для каждого из следующих элементов: scientificName
, size
, diet
и additional
. Они сдержат строки, целые числа, массивы и объекты.
Поскольку вы создаете объект, вы можете добавить их в любом желаемом порядке. Использование алфавитного порядка повышает читаемость списка свойств, особенно для больших списков. Также вы можете добавить их в одной строке, но их разделение на отдельные строки делает код более читабельным.
Сохраните и закройте файл. Откройте AnimalCard.js
.
На этот раз выполните деструктуризацию свойств списка параметров функции и используйте данные в компоненте:
После получения данных вы можете добавить scientificName
и size
в теги заголовка, но вам нужно превратить массив в строку, чтобы React мог отобразить их на странице. Вы можете сделать это с помощью join(', ')
, который будет создавать разделенный запятой список.
Сохраните и закройте файл. Сделав это и обновив браузер, вы увидите структурированные данные.
Вы можете создать аналогичный список с объектом additional
, но вместо этого добавьте функцию для оповещения пользователя с данными. Это даст вам возможность передавать функции в виде свойств, а затем использовать данные внутри компонента при вызове функции.
Откройте App.js
:
Создайте функцию showAdditionalData
, которая будет конвертировать объект в строку и отображать ее в качестве оповещения.
Функция showAdditional
конвертирует объект в массив пар, где первый элемент — это ключ, а второй — значение. Затем она преобразовывает данные, конвертируя пару ключей в строку. После этого функция добавляет разделитель строки \n
, прежде чем передавать полную строку в сигнальную функцию.
Поскольку JavaScript может принимать функции в качестве аргументов, React также может принимать функции в качестве свойств. Поэтому вы можете передать showAdditional
в AnimalCard
в качестве свойства с именем showAdditional
.
Сохраните и закройте файл. Откройте AnimalCard
:
Извлеките функцию showAdditional
из объекта свойства, затем создайте <button>
с событием onClick
, которое вызывает функцию с объектом additional
:
Сохраните файл. Сделав это и обновив браузер, вы увидите кнопку после каждой карточки. При нажатии на кнопку, вы получите оповещение с дополнительными данными.
Если вы попробуете нажать More Info для карточки Lion
, то получите ошибку. Это связано с тем, что для льва дополнительные данные отсутствуют. Вы увидите, как исправить это, в шаге 3.
В заключение давайте добавим немного оформления в наш проект. Добавьте className
для animal-wrapper
в div в AnimalCard
:
Сохраните и закройте файл. Откройте AnimalCard.css
:
Добавьте CSS для добавления тонкой границы и отступа для карточек и кнопки:
Это код CSS добавит небольшую границу для карточки и заменит стиль кнопки, используемый по умолчанию, на границу и отступ. cursor: pointer
будет менять курсор при наведении на кнопку.
Сохраните и закройте файл. После выполнения этих действий и обновления браузера вы увидите данные в отдельных карточках.
На данный момент вы создали два пользовательских компонента. Вы передали данные второму компоненту из первого компонента, используя свойства. Свойства включают разные данные, такие как строки, целые числа, массивы, объекты и функции. В вашем втором компоненте вы использовали свойства для создания динамического компонента с помощью JSX.
В следующем шаге вы будете использовать типизированную систему prop-types
для указания структуры, которую ваш компонент ожидает увидеть, что будет обеспечивать предсказуемость в приложении и предотвращать ошибки.
PropTypes
и defaultProps
На этом шаге вы добавите простую систему типизации для ваших компонентов с помощью PropTypes
. PropTypes
действуют как прочие системы типизации, прямо определяя тип данных, который вы ожидаете получить от определенного свойства. Они также дают вам возможность определять данные по умолчанию в случаях, когда свойство не всегда требуется. В отличие от большинства систем типизации, PropTypes
выполняет проверку при исполнении, так что если свойства не соответствуют типу, код скомпилируется, но в консоли будет отображена ошибка.
К концу этого шага вы обеспечите предсказуемость вашего пользовательского компонента, определив тип для каждого свойства. Это позволит гарантировать, что другой человек, который будет работать с компонентом, будет иметь четкое представление о структуре данных, которая требуется компоненту.
Пакет prop-types
устанавливается вместе с Create React App, поэтому для его использования необходимо только импортировать его в ваш компонент.
Откройте AnimalCard.js
:
Затем импортируйте PropTypes
из prop-types
:
Добавьте PropTypes
прямо в функцию компонента. В JavaScript функции являются объектами, что означает, что вы можете добавить свойства, используя точечный синтаксис. Добавьте следующие PropTypes
в AnimalCard.js
:
Сохраните и закройте файл.
Как видите, существует множество разных PropTypes
. Это только небольшой пример; изучите официальную документацию React, чтобы узнать об остальных типах, которые вы можете использовать.
Давайте начнем со свойства name
. Здесь вы указываете, что в name
должна находиться строка
. Свойство scientificName
аналогично предыдущему примеру. size
— число
, которое может включать как числа с плавающей точкой, например, 1.5
, так и целые числа, например 6
. showAdditional
— это функция (func
).
diet
же имеет определенные отличия. В данном случае вы указываете, что diet
представляет собой массив
, но вам также необходимо указать, что будет содержать этот массив. В нашем случае массив будет содержать только строки. Если вы хотите смешивать типы, то можете использовать другое свойство oneOfType
, которое принимает массив валидных значений PropTypes
. Вы можете использовать oneOfType
где угодно, так что если вы хотите, чтобы size
принимал числа или строки, внесите следующие изменения:
Свойство additional
также немного более сложное. В этом случае вы указываете объект, но, чтобы внести большую ясность, вы указываете, что должен содержать объект. Для этого вы можете использовать PropTypes.shape
, принимающий объект с дополнительными полями, которым требуются собственные значения PropTypes
. В нашем случае link
и notes
имеют значение PropTypes.string
.
В настоящее время все данные имеют правильную форму и отвечают свойствам. Чтобы узнать, что произойдет, если значение PropTypes
не будет совпадать, откройте ваши данные:
Измените для size значение на строку в первом элементе:
Сохраните файл. После выполнения этих действий и обновления браузера вы увидите ошибку в консоли.
Errorindex.js:1 Warning: Failed prop type: Invalid prop `size` of type `string` supplied to `AnimalCard`, expected `number`.
in AnimalCard (at App.js:18)
in App (at src/index.js:9)
in StrictMode (at src/index.js:8)
В отличие от других систем типизации, таких как TypeScript, PropTypes
не будет генерировать предупреждение на этапе сборки, поэтому если ошибки кода отсутствуют, то код все равно скомпилируется. Это означает, что вы можете случайно опубликовать код с ошибками свойств.
Измените данные обратно на правильный тип:
Сохраните и закройте файл.
Откройте AnimalCard.js
:
Каждое свойство, за исключением additional
, имеет параметр isRequired
. Это означает, что они должны быть обязательно указаны. Если вы не укажете обязательное свойство, код все равно скомпилируется, но вы получите ошибку исполнения в консоли.
Если свойство не обязательное, вы можете добавить значение по умолчанию. Рекомендуется всегда добавлять значение по умолчанию для предотвращения ошибок при исполнении, если свойство не обязательное. Например, в компоненте AnimalCard
вы вызываете функцию с данными additional
. Если их там нет, функция попытается получить их и изменить несуществующий объект, в результате чего приложение упадет.
Чтобы предотвратить эту проблему, добавьте значение defaultProp
для additional
:
Вы добавляете значение defaultProps
в функцию, используя точечный синтаксис, как вы это делали для propTypes
, затем вы добавляете значение по умолчанию, которое компонент должен использовать, если свойство не определено
. В нашем случае вы подставляете форму additional
, включая сообщение, которое не содержит дополнительной информации.
Сохраните и закройте файл. После этого обновите браузер. После обновления страницы нажмите кнопку More Info карточки Lion. У нее нет поля additional
в данных, поэтому свойство не определено
. Но AnimalCard
будет заменять свойство по умолчанию.
Теперь ваши свойства хорошо задокументированы и являются либо обязательными, либо имеют значение по умолчанию для обеспечения предсказуемого кода. Это позволит будущим разработчикам (в том числе вам) понимать, какие свойства требуются компоненту. Это облегчит повторное использование ваших компонентов, предоставляя вам полную информацию о том, как компонент будет использовать данные, которые он получает.
В этом руководстве вы создали несколько компонентов, которые используют свойства для отображения информации из родительского элемента. Свойства дают вам гибкость, необходимую для разбивки крупных компонентов на более мелкие и понятные части. Теперь, когда ваши данные больше не имеют тесной привязки к отображаемой информации, вы можете самостоятельно делать выбор в отношении сегментации вашего приложения.
Свойства — это важнейший инструмент для создания сложных приложений, дающий возможность создания компонентов, которые могут адаптироваться к получаемым данным. С помощью PropTypes
вы создаете предсказуемые и понятные компоненты, которые дадут команде возможность повторно использовать работу друг друга для создания гибкой и стабильной базы кода. Если вас интересуют другие обучающие модули по React, ознакомьтесь с нашей страницей тем по React или вернитесь на страницу серии Программирование на React.js.
Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases.
This textbox defaults to using Markdown to format your answer.
You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!