Полезные видео о фронтенде. Подпишись на Rutube

Как типизировать с TypeScript?

2 года назад·14 мин. на чтение

В этой статье рассмотрим самые популярные типы, которые используются в JavaScript коде, и объясним способы описания этих типов в TypeScript.

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

Примитивы: `string`, `number`, `boolean`

В JavaScript есть три очень часто используемых примитива: string, number и boolean. У каждого есть соответствующий тип в TypeScript. Как и следовало ожидать, это те же самые имена, которые вы увидели бы, если бы использовали оператор JavaScript typeof для значений этих типов:

string представляет строковые значения, такие как "Hello, world"
number для чисел вроде 42. В JavaScript нет различий между целочисленными значениями и значениями с плавающей точкой, поэтому нет эквивалента int или float — все просто number
boolean для двух значений true и false

Типы String, Number и Boolean (начинающиеся с заглавных букв) допустимы, но относятся к некоторым специальным встроенным типам, которые очень редко встречаются в коде. Всегда используйте типы string, number или boolean.

Типизация массивов

Чтобы указать тип массива, например [1, 2, 3], вы можете использовать синтаксис number[]; этот синтаксис работает для любого типа (например, string[] — это массив строк и т.д.). Вы также можете встретить синтаксис Array<number>, что означает то же самое. Обратите внимание, что [number] — это не массив чисел, а кортеж (tuple).

Тип `any`

TypeScript также имеет специальный тип any, который вы можете использовать всякий раз, когда вы не хотите, чтобы определенное значение вызывало ошибки проверки типов. Когда значение имеет тип any, вы можете получить доступ к любым его свойствам (которые, в свою очередь, будут иметь тип any), вызвать его как функцию, присвоить ему значения любого типа или почти все что угодно. Это валидный синтаксис:

let obj: any = { x: 0 };
// Ни одна из следующих строк кода не вызовет ошибок компилятора.
// Использование any отключает все дальнейшие проверки типов и предполагается, что
// вы знаете эти сценарии лучше, чем TypeScript.

obj.foo();
obj();
obj.bar = 100;
obj = 'hello';
const n: number = obj;

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

`noImplicitAny`

Когда вы не указываете тип и TypeScript не может вывести его из контекста, компилятор обычно по умолчанию использует тип any. Обычно этого следует избегать, потому что тип any не проверяется. Используйте флаг компилятора noImplicitAny, чтобы пометить любое неявное значение any как ошибку.

Аннотации типов переменных

Когда вы объявляете переменную с помощью const, var или let, вы можете дополнительно добавить аннотацию типа, чтобы явно указать тип переменной:

let myName: string = 'Alice';

TypeScript не использует объявления в стиле «типы слева», такие как int x = 0; Аннотации типа всегда будут находится после. Однако в большинстве случаев в этом нет необходимости. Везде, где это возможно, TypeScript пытается автоматически определить типы в вашем коде. Например, тип переменной выводится на основе типа ее инициализатора:

// Аннотации типа не требуются — тип 'myName' выводится как 'string'
let myName = 'Alice';

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

Как типизировать функции в TypeScript?

Функции — это основное средство для работы с данными в JavaScript. TypeScript позволяет указывать типы как входных, так и выходных значений функций.

Аннотации типов параметров

Когда вы объявляете функцию, вы можете добавить аннотации типа после каждого параметра, чтобы объявить, какие типы параметров принимает функция. Аннотации типа параметра идут после имени параметра:

// Аннотация типа параметра
function greet(name: string) {
  console.log('Hello, ' + name.toUpperCase() + '!!');
}

Когда параметр имеет аннотацию типа, будут проверены аргументы этой функции:

// При вызове возникнет ошибка времени выполнения
greet(42);

// Argument of type 'number' is not assignable to parameter of type 'string'.

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

Аннотации типа возвращаемого значения

Вы также можете добавить аннотации типа возвращаемого значения. Аннотации типа возвращаемого значения добавляется после списка параметров:

function getFavoriteNumber(): number {
  return 26;
}

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

Анонимные функции

Анонимные функции немного отличаются от объявлений обычных функций. Когда функция появляется в месте, где TypeScript может определить, как она будет вызываться, параметрам этой функции автоматически присваиваются типы. Например:

// Здесь нет аннотаций типов, но TypeScript может обнаружить ошибку
const names = ['Alice', 'Bob', 'Eve'];

// Определение типа на основе контекста
names.forEach(function (s) {
  console.log(s.toUppercase());

  // Property 'toUppercase' does not exist on type 'string'. Did you mean 'toUpperCase'?
  // В типе 'string' нет свойства 'toUppercase'. Возможно, вы имели ввиду 'toUpperСase'?
});

// Определение типа на основе контекста вызова функции также работает и для стрелочных функций
names.forEach((s) => {
  console.log(s.toUppercase());

  // Property 'toUppercase' does not exist on type 'string'. Did you mean 'toUpperCase'?
  // В типе 'string' нет свойства 'toUppercase'. Возможно, вы имели ввиду 'toUpperСase'?
});

Несмотря на то, что у параметра s не было аннотации типа, TypeScript использовал типы функции forEach вместе с предполагаемым типом массива, чтобы определить тип, который будет иметь s. Этот процесс называется контекстной типизацией, потому что контекст, в котором возникла функция, сообщает, какой тип она должна иметь. Как и в случае с правилами вывода, вам не нужно явно знать, как это происходит, но понимание того, что это действительно происходит, может помочь вам заметить, когда аннотации типов не нужны. Позже мы увидим больше примеров того, как контекст, в котором встречается значение, может повлиять на его тип.

Как типизировать объекты в TypeScript?

Помимо примитивов, наиболее распространенным типом, с которым вы столкнетесь, является объект. Это относится к любому значению JavaScript со свойствами. Чтобы определить тип объекта, мы просто перечисляем его свойства и их типы. Например, вот функция, которая принимает объект точку:

// Аннотация типа параметра является типом объекта
function printCoord(pt: { x: number; y: number }) {
  console.log("The coordinate's x value is " + pt.x);
  console.log("The coordinate's y value is " + pt.y);
}
printCoord({ x: 3, y: 7 });

Здесь мы типизировали параметр двумя свойствами — x и y — оба типа number. Вы можете использовать , или ; для разделения свойств, а последний разделитель необязателен. Указание типа каждого свойства также необязательно. Если вы не укажете тип, он будет считаться any.

Необязательные свойства

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

function printName(obj: { first: string; last?: string }) {
  // ...
}

// Следующие вызовы не вызовут ошибок
printName({ first: 'Bob' });
printName({ first: 'Alice', last: 'Alisson' });

В JavaScript, если вы обращаетесь к несуществующему свойству, вы получите значение undefined, а не ошибку времени выполнения. Из-за этого, когда вы читаете из необязательного свойства, вам придется проверять его на undefined перед его использованием.

function printName(obj: { first: string; last?: string }) {
  // Ошибка, если obj.last не предоставлен:
  console.log(obj.last.toUpperCase());
Object is possibly 'undefined'.
  if (obj.last !== undefined) {
    // OK
    console.log(obj.last.toUpperCase());
  }

  // Безопасная альтернатива с использованием современного синтаксиса JavaScript:
  console.log(obj.last?.toUpperCase());
}

Объединение типов (Unions)

Система типов TypeScript позволяет вам создавать новые типы из существующих, используя большое количество операторов. Теперь, когда мы знаем, как писать несколько типов, пора начать комбинировать их интересными способами.

Определение объединенного типа

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

function printId(id: number | string) {
  console.log('Your ID is: ' + id);
}

// Работает
printId(101);

// Работает
printId('202');

// Ошибка
printId({ myID: 22342 });

// Argument of type '{ myID: number; }' is not assignable to parameter of type 'string | number'.

Работа с объединенными типами

TypeScript разрешит операцию только в том случае, если она действительна для каждого члена объединения. Например, если у вас есть объединение string | number, вы не можете использовать методы, доступные только для string:

function printId(id: number | string) {
  console.log(id.toUpperCase());

  // Property 'toUpperCase' does not exist on type 'string | number'.
  // Property 'toUpperCase' does not exist on type 'number'.
}

Решение состоит в том, чтобы сузить объединение с помощью кода, как в JavaScript без аннотаций типов. Сужение происходит, когда TypeScript может определить более конкретный тип для значения на основе структуры кода. Например, TypeScript знает, что только строковое значение будет иметь значение "string" при применении оператора typeof:

function printId(id: number | string) {
  if (typeof id === 'string') {
    // Здесь id имеет тип 'string'
    console.log(id.toUpperCase());
  } else {
    // Здесь id имеет тип 'number'
    console.log(id);
  }
}

Другой пример — использование такой функции, как Array.isArray:

function welcomePeople(x: string[] | string) {
  if (Array.isArray(x)) {
    // Здесь: 'x' это 'string[]'
    console.log('Hello, ' + x.join(' and '));
  } else {
    // Здесь: 'x' это 'string'
    console.log('Welcome lone traveler ' + x);
  }
}

Обратите внимание, что в ветке else нам не нужно делать ничего особенного — если x не является string[], то это должна быть строка. Иногда у вас будет объединение, в котором все члены имеют что-то общее. Например, и массивы, и строки имеют метод slice. Если у каждого члена объединения есть общее свойство, вы можете использовать это свойство без сужения:

// Возвращаемый тип определяется из number[] | string
function getFirstThree(x: number[] | string) {
  return x.slice(0, 3);
}

Может сбивать с толку тот факт, что объединение типов имеет пересечение свойств этих типов. Это не случайно — название union происходит из теории типов. Объединение number | string состоит из объединения значений каждого типа. Обратите внимание, что для двух множеств с соответствующими фактами о каждом множестве к объединению самих множеств применимо только пересечение этих фактов. Например, если бы у нас была комната с высокими людьми в шляпах и другая комната с говорящими по-испански в шляпах, после объединения этих комнат единственное, что мы знаем о каждом человеке, это то, что он должен быть в шляпе.

Псевдонимы типов (алиасы, aliases)

Мы использовали типы объектов и типы объединения, записывая их непосредственно в аннотациях типов. Это удобно, но часто хочется использовать один и тот же тип более одного раза и ссылаться на него по одному имени. Псевдоним типа — это именно то, что является именем для любого типа. Синтаксис псевдонима типа:

type Point = {
  x: number;
  y: number;
};

// Тоже самое как и в прошлом примере
function printCoord(pt: Point) {
  console.log("The coordinate's x value is " + pt.x);
  console.log("The coordinate's y value is " + pt.y);
}

printCoord({ x: 100, y: 100 });

Вы можете использовать псевдоним типа, чтобы дать имя любому типу, а не только объектному типу. Например, псевдоним типа может включать тип объединения:

type ID = number | string;

Обратите внимание, что псевдонимы — это всего лишь псевдонимы — вы не можете использовать псевдонимы типов для создания разных/отличных «версий» одного и того же типа. Другими словами, этот код может выглядеть недопустимым, но в соответствии с TypeScript это нормально, потому что оба типа являются псевдонимами для одного и того же типа:

type UserInputSanitizedString = string;

function sanitizeInput(str: string): UserInputSanitizedString {
  return sanitize(str);
}

// Значение типа UserInputSanitizedString
let userInput = sanitizeInput(getInput());

// может также присваивать строку
userInput = 'new input';

Интерфейсы

Объявление интерфейса — это еще один способ объявить тип объекта:

interface Point {
  x: number;
  y: number;
}

function printCoord(pt: Point) {
  console.log("The coordinate's x value is " + pt.x);
  console.log("The coordinate's y value is " + pt.y);
}

printCoord({ x: 100, y: 100 });

Точно так же, как когда мы использовали псевдоним типа выше, пример работает так же, как если бы мы использовали анонимный тип объекта. TypeScript заботится только о структуре значения, которое мы передали в printCoord, — то, что оно имеет ожидаемые свойства. Занимаясь только структурой и возможностями типов, мы называем TypeScript структурно типизированной (structurally typed) системой типов.

Различия типа и интерфейса в TypeScript

Псевдонимы типов (type) и интерфейсы очень похожи, и во многих случаях вы можете свободно выбирать между ними. Почти все возможности интерфейса доступны в типе, ключевое отличие состоит в том, что тип нельзя повторно открыть для добавления новых свойств по сравнению с интерфейсом, который всегда расширяем. Расширение интерфейса:

interface Animal {
  name: string;
}

interface Bear extends Animal {
  honey: boolean;
}

const bear = getBear();
bear.name;
bear.honey;

Расширение типа через пересечения:

type Animal = {
  name: string;
};

type Bear = Animal & {
  honey: boolean;
};

const bear = getBear();
bear.name;
bear.honey;

Добавление новых полей в существующий интерфейс:

interface Window {
  title: string;
}

interface Window {
  ts: TypeScriptAPI;
}

const src = 'const a = "Hello World"';
window.ts.transpileModule(src, {});

Тип нельзя изменить после создания:

type Window = {
  title: string;
};

type Window = {
  ts: TypeScriptAPI;
};

// Error: Duplicate identifier 'Window'

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

До TypeScript версии 4.2 имена псевдонимов могут появляться в сообщениях об ошибках, иногда вместо эквивалентного анонимного типа. Интерфейсы всегда будут иметь имена в сообщениях об ошибках.
Псевдонимы типов не могут участвовать в слиянии объявлений, но интерфейсы могут.
Интерфейсы могут использоваться только для объявления форм объектов, а не для переименования примитивов.
Имена интерфейсов всегда будут отображаться в исходном виде в сообщениях об ошибках, но только тогда, когда они используются по имени.

По большей части вы можете выбирать на основе личных предпочтений, и TypeScript сообщит вам, нужно ли ему что-то еще. В общем, используйте интерфейс, пока вам не понадобятся возможности типа.

Утверждения типа (Type Assertions)

Иногда у вас будет информация о типе значения, о котором TypeScript не может узнать. Например, если вы используете document.getElementById, TypeScript знает только, что это вернет какой-то HTMLElement, но вы можете знать, что на вашей странице всегда будет HTMLCanvasElement с заданным идентификатором. В этой ситуации вы можете использовать утверждение типа, чтобы указать более конкретный тип:

const myCanvas = document.getElementById('main_canvas') as HTMLCanvasElement;

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

const myCanvas = <HTMLCanvasElement>document.getElementById('main_canvas');

TypeScript допускает только утверждения типа, которые преобразуются в более конкретную или менее конкретную версию типа. Это правило предотвращает «невозможные» приведения, такие как:

const x = 'hello' as number;

// Conversion of type 'string' to type 'number' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first.
// Преобразование типа 'string' в тип 'number' может быть ошибкой, поскольку ни один из типов в достаточной степени не перекрывает другой. Если это было сделано намеренно, сначала преобразуйте выражение к типу 'unknown'.

Иногда это правило может быть слишком консервативным и запрещать более сложные приведения, которые могут быть действительными. Если это произойдет, вы можете использовать два утверждения, сначала для any (или unknown), затем для нужного типа:

const a = expr as any as T;

Литеральные типы (Literal Types)

В дополнение к общим типам string и number мы можем ссылаться на определенные строки и числа в позициях типа. Один из способов это представить — рассмотреть, как в JavaScript существуют различные способы объявления переменных. И var, и let позволяют изменять содержимое переменной, а const — нет. Это отражено в том, как TypeScript создает типы для литералов.

let changingString = 'Hello World';
changingString = 'Olá Mundo';

// Поскольку `changingString` может представлять любую возможную строку, именно так TypeScript описывает ее в системе типов

const constantString = 'Hello World';
// Поскольку `constantString` может представлять только 1 возможную строку, она имеет буквальное представление типа.

Сами по себе литеральные типы не очень ценны:

let x: 'hello' = 'hello';

// Работает
x = 'hello';
// ...
x = 'howdy';
// Type '"howdy"' is not assignable to type '"hello"'.
// Тип '"howdy"' нельзя назначить типу '"hello"'.

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

function printText(s: string, alignment: 'left' | 'right' | 'center') {
  // ...
}
printText('Hello, world', 'left');
printText("G'day, mate", 'centre');

// Argument of type '"centre"' is not assignable to parameter of type '"left" | "right" | "center"'.
// Аргумент типа '"centre"' нельзя назначить параметру типа '"left" | "right" | "center"'.

Типы числовых литералов работают так же:

function compare(a: string, b: string): -1 | 0 | 1 {
  return a === b ? 0 : a > b ? 1 : -1;
}

Конечно, вы можете комбинировать их с нелитеральными типами:

interface Options {
  width: number;
}
function configure(x: Options | 'auto') {
  // ...
}
configure({ width: 100 });
configure('auto');
configure('automatic');

// Argument of type '"automatic"' is not assignable to parameter of type 'Options | "auto"'.
// Аргумент типа '"automatic"' нельзя назначить параметру типа 'Options | "auto"'.

Есть еще один вид литералов: boolean литералы. Есть только два типа логических литералов, и, как вы могли догадаться, это true и false. Сам тип boolean на самом деле является просто псевдонимом объединения true | false.

Вывод литералов

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

const obj = { counter: 0 };
if (someCondition) {
  obj.counter = 1;
}

TypeScript не считает, что присвоение 1 полю, которое ранее имело 0, является ошибкой. Другой способ выразить тоже самое это то, что obj.counter должен иметь тип number, а не 0, потому что типы используются для определения поведения как при чтении, так и при записи. То же самое относится и к строкам:

const req = { url: 'https://example.com', method: 'GET' };
handleRequest(req.url, req.method);

// Argument of type 'string' is not assignable to parameter of type '"GET" | "POST"'.
// Аргумент типа 'string' нельзя назначить параметру типа '"GET" | "POST"'.

В приведенном выше примере req.method подразумевается как строка, а не как "GET". Поскольку код можно обработать между созданием req и вызовом handleRequest, который может назначить новую строку, например "GUESS", для req.method, TypeScript считает, что этот код содержит ошибку. Есть два способа решить это.

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

// Изменение 1:
const req = { url: 'https://example.com', method: 'GET' as 'GET' };

// Изменение 2:
handleRequest(req.url, req.method as 'GET');

Изменение 1 означает: "Я говорю, что req.method всегда имеет литеральный тип "GET"", предотвращая возможное назначение "GUESS" этому полю после этого. Изменение 2 означает "Я знаю, что req.method имеет значение "GET"". Вы можете использовать as const для преобразования всего объекта в литералы типов:

const req = { url: 'https://example.com', method: 'GET' } as const;
handleRequest(req.url, req.method);

Суффикс as const действует как const, но для системы типов, гарантируя, что всем свойствам будет присвоен литеральный тип, а не более общая версия, такая как string или number.

`null` и `undefined`

В JavaScript есть два примитивных значения, которые используются для обозначения отсутствия или неинициализации значения: null и undefined. TypeScript имеет два соответствующих типа с соответствующими именами. Поведение этих типов зависит от того, включена ли у вас опция strictNullChecks.

`strictNullChecks` выключен

Если strictNullChecks выключен, значения, которые могут быть null или undefined, по-прежнему могут быть доступны в обычном режиме, а значения null или undefined могут быть присвоены свойству любого типа. Это похоже на то, как ведут себя языки без проверок на null (например, C#, Java). Отсутствие проверки этих значений, как правило, является основным источником ошибок; мы всегда рекомендуем включать strictNullChecks, если это целесообразно в кодовой базе.

`strictNullChecks` включен

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

function doSomething(x: string | null) {
  if (x === null) {
    // …
  } else {
    console.log('Hello, ' + x.toUpperCase());
  }
}

Оператор ненулевого утверждения (Non-null Assertion Operator, постфикс `!`)

TypeScript также имеет специальный синтаксис для удаления null и undefined из типа без какой-либо явной проверки. Добавление ! после выражения фактически является утверждением того, что значение не является null или undefined:

function liveDangerously(x?: number | null) {
  // No error
  console.log(x!.toFixed());
}

Как и другие утверждения типа, это не меняет поведение вашего кода во время выполнения, поэтому важно использовать только ! когда вы знаете, что значение не может быть null или undefined.

Что такое Enums в TypeScript (Перечисления)?

Перечисления — это функциональность, добавленная TypeScript, которая позволяет описывать значение, которое может быть одной из множества возможных именованных констант. В отличие от большинства возможностей TypeScript, это не дополнение к JavaScript на уровне типов, а нечто, добавленное к языку и среде выполнения.

enum Direction {
  Up,
  Down,
  Left,
  Right,
}

Менее распространенные примитивы

Стоит упомянуть остальные примитивы в JavaScript, представленные в системе типов.

`bigint`

Начиная с ES2020, в JavaScript есть примитив, используемый для очень больших целых чисел, BigInt:

// Создание значения bigint через функцию BigInt
const oneHundred: bigint = BigInt(100);

// Создание значения BigInt через литеральный синтаксис
const anotherHundred: bigint = 100n;

`symbol`

В JavaScript есть примитив, используемый для создания глобальной уникальной ссылки с помощью функции Symbol():

const firstName = Symbol('name');
const secondName = Symbol('name');

if (firstName === secondName) {
  // Это условие всегда будет возвращать 'false', поскольку типы 'typeof firstName' и 'typeof secondName' не пересекаются.
}

Frontend TypeScript

Как передать компонент в качестве пропса в React

год назад·4 мин. на чтение

Существует множество способов передать компонент в качестве пропса

Существует множество способов передать компонент в качестве пропса, например, специальный проп children, и паттерн render prop. О них вы можете узнать в видео “Паттерн Render Props в ReactJS”. В случае с render props мы передаем функцию, которая возвращает компонент. В этой статье рассмотрим как передать просто компонент в качестве пропса. В этой статье мы увидим простую технику, которая позволяет писать удобные настраиваемые компоненты с помощью простых API, просто используя основные строительные блоки React - компоненты. Опытный React разработчик использует эту технику естественным образом, но новичку сложно понять этот механизм.

Переизбыток пропсов

Иногда в компонент приходится передавать огромное количество пропсов для того чтобы настроить более мелкие вложенные компоненты, из которых состоит ваш компонент. Возникает переизбыток пропсов. Давайте посмотрим на это на примере. Предположим, есть компонент Alert с Button внутри.

const Button = ({ onClick, children }) => <button onClick={onClick}>{children}</button>;

const Alert = ({ children, onAccept }) => (
  <div className="alert">
    <div className="alert-header">
      <h1>Alert!</h1>
    </div>
    <div className="alert-content">{children}</div>
    <div className="alert-footer">
      <Button onClick={onAccept}>Ok</Button>
    </div>
  </div>
);

<Alert onAccept={() => {}}>Attention!</Alert>

Что вы можете сделать, чтобы настроить внутренний Button? Если вы новичок в React вы, вероятно, думаете, что правильный способ - это передать проп.

const Alert = ({ children, acceptMessage = "Ok", onAccept }) => (
  <div className="alert">
    <div className="alert-header">
      <h1>Alert!</h1>
    </div>
    <div className="alert-content">{children}</div>
    <div className="alert-footer">
      <Button onClick={onAccept}>{acceptMessage}</Button>
    </div>
  </div>
);


<Alert acceptMessage="Understood!" onAccept={() => {}}>
  Attention!
</Alert>

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

const Confirm = ({ children, acceptMessage = "Ok", rejectMessage = "Cancel", onAccept, onReject }) => (
  <div className="confirm">
    <div className="confirm-header">
      <h1>Confirm</h1>
    </div>
    <div className="confirm-content">{children}</div>
    <div className="confirm-footer">
      <Button onClick={onAccept}>{acceptMessage}</Button>
      <Button onClick={onReject}>{rejectMessage}</Button>
    </div>
  </div>
);


<Confirm acceptMessage="Yep" rejectMessage="Nope" onAccept={() => {}} onReject={() => {}}>
  You sure?
</Confirm>

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

Улучшение. Вложенные пропсы

Один из способов немного привести код в порядок — вложить пропсы: по одному пропсу для каждого внутреннего компонента с необходимыми ключами.

const Confirm = ({
  children,
  onAccept,
  onReject,
  acceptButton = {
    message: "Ok",
    className: "accept-btn",
  },
  rejectButton = {
    message: "Cancel",
    className: "cancel-btn",
  },
}) => (
  <div className="confirm">
    <div className="confirm-header">
      <h1>Confirm</h1>
    </div>
    <div className="confirm-content">{children}</div>
    <div className="confirm-footer">
      <Button className={acceptButton.className} onClick={onAccept}>
        {acceptButton.message}
      </Button>
      <Button className={rejectButton.className} onClick={onReject}>
        {rejectButton.message}
      </Button>
    </div>
  </div>
);

<Confirm
  acceptButton={{ message: "Yep", className: "accept-btn" }}
  rejectButton={{ message: "Nope", className: "reject-btn" }}
  onAccept={() => {}}
  onReject={() => {}}
>
  You sure?
</Confirm>

Это исправляет конфликты, но все становится сложнее. Что произойдет, если я захочу переопределить только один вложенный проп? Чтобы сделать это, нам нужно вручную объединить пропсы со значениями по умолчанию. И что произойдет, если Button также содержит Icon? Следует ли использовать пару новых пропсов (acceptButtonIcon, rejectButtonIcon)? Должны ли вы вкладывать их в существующие пропсы (acceptButton.icon)? Типы или prop types будет очень сложно читать.

Другой подход. Render props

Render props это один из способов сделать ваши компоненты действительно настраиваемыми, вместо того, чтобы добавлять массу пропсов. Давайте попробуем. Напишем три разные версии компонента Confirm, который принимает рендер пропсы.

Версия 1. По одному рендер пропсу для каждой кнопки

В первой версии в компоненте Confirm добавим по одному рендер пропсу для каждой кнопки:

const Confirm = ({
  children,
  onAccept,
  onReject,
  renderAcceptButton = onAccept => (
    <Button className="accept-btn" onClick={onAccept}>
      OK
    </Button>
  ),
  renderRejectButton = onReject => (
    <Button className="reject-btn" onClick={onReject}>
      Cancel
    </Button>
  ),
}) => (
  <div className="confirm">
    <div className="confirm-header">
      <h1>Confirm</h1>
    </div>
    <div className="confirm-content">{children}</div>
    <div className="confirm-footer">
      {renderAcceptButton(onAccept)}
      {renderRejectButton(onReject)}
    </div>
  </div>
);

<Confirm
  renderAcceptButton={onAccept => (
    <Button className="accept-btn" onClick={onAccept}>
      Yep
    </Button>
  )}
  renderRejectButton={onReject => (
    <Button className="cancel-btn" onClick={onReject}>
      Nope
    </Button>
  )}
>
  You sure?
</Confirm>

Версия 2. Один рендер проп для всех кнопок

Вторая версия - это один рендер проп для всех кнопок.

const Confirm = ({
  children,
  onAccept,
  onReject,
  renderButtons = (onAccept, onReject) => (
    <>
      <Button className="accept-btn" onClick={onAccept}>
        OK
      </Button>
      <Button className="reject-btn" onClick={onReject}>
        Cancel
      </Button>
    </>
  ),
}) => (
  <div className="confirm">
    <div className="confirm-header">
      <h1>Confirm</h1>
    </div>
    <div className="confirm-content">{children}</div>
    <div className="confirm-footer">{renderButtons(onAccept, onReject)}</div>
  </div>
);

<Confirm
  renderButtons={(onAccept, onReject) => (
    <>
      <Button className="accept-btn" onClick={onAccept}>
        Yep
      </Button>
      <Button className="cancel-btn" onClick={onReject}>
        Nope
      </Button>
    </>
  )}
>
  You sure?
</Confirm>

Версия 3. Один рендер проп для всех подкомпонентов

И, наконец, рендер проп для всего компонента:

const Confirm = ({
  children,
  onAccept,
  onReject,
  render = (onAccept, onReject, children) => (
    <div className="confirm">
      <div className="confirm-header">
        <h1>Confirm</h1>
      </div>
      <div className="confirm-content">{children}</div>
      <div className="confirm-footer">
        <Button className="accept-btn" onClick={onAccept}>
          OK
        </Button>
        <Button className="reject-btn" onClick={onReject}>
          Cancel
        </Button>
      </div>
    </div>
  ),
}) => render(onAccept, onReject, children);

<Confirm
  render={() => {
    // компонент, который появится внутри `Confirm`
  }}
>
 You sure?
</Confirm>

Последний вариант своего рода крайность. Рендер пропсы настолько мощный, насколько это возможно, но он также имеет свои нюансы. Они позволяют изменить способ рендеринга компонента, но повторно использовать «значения по умолчанию» непросто. Это зависит от того, что визуализирует ваш рендер проп. В предыдущих примерах мы видели три варианта, каждый из которых обеспечивает большую гибкость, но меньшую возможность повторного использования «значений по умолчанию». Однако этот подход может показаться излишним, когда мы просто хотим настроить текст кнопок Alert/Confirm.

Просто передать компонент

const Confirm = ({
  children,
  onAccept,
  onReject,
  acceptButton = <Button>Ok</Button>,
  rejectButton = <Button>Cancel</Button>,
}) => (
  <div className="confirm">
    <div className="confirm-header">
      <h1>Confirm</h1>
    </div>
    <div className="confirm-content">{children}</div>
    <div className="confirm-footer">
      {React.cloneElement(acceptButton, { className: "accept-btn", onClick: onAccept })}
      {React.cloneElement(rejectButton, { className: "reject-btn", onClick: onReject })}
    </div>
  </div>
);

<Confirm
  acceptButton={<Button>Yep</Button>}
  rejectButton={<Button>Nope</Button>}
  onAccept={() => {}}
  onReject={() => {}}
>
  You sure?
</Confirm>

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

<Confirm
  acceptButton={<Button onAccept={() => {}}>Yep</Button>}
  rejectButton={<Button onReject={() => {}}>Nope</Button>}
>
  You sure?
</Confirm>

Frontend React