React
ブラウザ向けのクイックスタートで、すでにReactアプリケーションの開発のセットアップの仕方を説明しています。要点をまとめると、次の通りです。
ファイル拡張子
.tsx(.tsの代わりに)を使用してください。tsconfig.jsonのcompilerOptionsで"jsx" : "react"を使ってください。JSXとReactの定義をあなたのプロジェクトにインストールします：(
npm i -D @types/react @types/react-dom)。reactを
.tsxファイルにインポートします(import React from "react"となります)。
ReactとTypeScriptのプロジェクトをセットアップする一番簡単な方法は、Create React Appを使うことです。このツールはReactチームから提供されているツールです。公式にTypeScriptのテンプレートが提供されています。Create React Appを使うには、$ npm i -g create-react-appというコマンドでローカルPCにグローバルにインストールできます。そうすれば、Reactの公式Webサイトに書かれているように$ npx create-react-app my-app --template typescriptというコマンドで、最初からTypeScriptを利用可能なプロジェクトを簡単に作成できます。
Reactは、HTMLタグ(文字列)または、React Component(クラス)を表示できます。これらのJavaScriptへのコンパイル結果は同じではありません(例えば、、React.createElement('div')とReact.createElement(MyComponent)のJavaScriptのコンパイル結果に同じではありません)。どちらとして扱われるかは、最初の文字のケース(大文字小文字)です。fooはHTMLタグとして扱われます。そして、Fooはコンポーネントとして扱われます。
HTMLタグfooの型はJSX.IntrinsicElements.fooです。これらの主要な型は、セットアップの一部としてインストールした型定義ファイルreact-jsx.d.tsの中で、予め定義されています。下記にその中に含まれる型定義のサンプルを示します。
declare module JSX {interface IntrinsicElements {a: React.HTMLAttributes;abbr: React.HTMLAttributes;div: React.HTMLAttributes;span: React.HTMLAttributes;/// などなど}}
単にReact.FCインターフェースを使ってステートレスなFunctionコンポーネントを定義することができます。React.FCは単に、React.FunctionComponentの短いバージョンです。
type Props = {foo: string;}const MyComponent: React.FC<Props> = (props) => {return <span>{props.foo}</span>}<MyComponent foo="bar" />
コンポーネントは、propsプロパティに基づいて型チェックされます。コンポーネントは、JSXが、どのように変換されるか、ということを考慮して型チェックされます。例えばJSXのタグの属性は、コンポーネントのpropsの一部である必要があります。
Reactのステートフルなコンポーネントを作成するには、クラスを使用します。型定義ファイルreact.d.tsは、React.Component<Props,State>クラスを定義しています。このクラスを、コンポーネントを作成するときに継承します。このクラスは、そのコンポーネント独自のPropsとStateの型をジェネリクスとして設定できるようになっています。これを以下の例で示します(下記の例では、Stateには空のオブジェクト型を設定しています)：
type Props = {foo: string;}class MyComponent extends React.Component<Props, {}> {render() {return <span>{this.props.foo}</span>}}<MyComponent foo="bar" />
ReactはJSXやstringをレンダリングすることができます。これらはすべてReact.ReactNode型に統合されていますので、レンダリング可能なものを受け入れる場合などに使用してください。
type Props = {header: React.ReactNode;body: React.ReactNode;}class MyComponent extends React.Component<Props, {}> {render() {return <div>{this.props.header}{this.props.body}</div>;}}<MyComponent header="これはヘッダーです" body="これはボディです" />
Reactの型定義ファイルは、React.ReactElement<T>という型を提供しています。これを、<T/>クラスコンポーネントのインスタンスを保持できる型アノテーションに利用できます。例えば以下の通りです:
class MyAwesomeComponent extends React.Component {render() {return <div>こんにちは</div>;}}const foo: React.ReactElement<MyAwesomeComponent> = <MyAwesomeComponent />; // Okayconst bar: React.ReactElement<MyAwesomeComponent> = <NotMyAwesomeComponent />; // Error!
もちろん、これを関数の引数や、コンポーネントのPropsの型として使用することもできます。
型React.Component<Props>はReact.ComponentClass<P> | React.StatelessComponent<P>のように２つの種類のコンポーネントの型を統合しています。なので、Props型を受け取り、JSXを使ってレンダリングする何かを受け入れることができます。
const X: React.Component<Props> = foo; // どこかから渡されたコンポーネント// XコンポーネントにPropsを渡して表示:<X {...props}/>;
これは、期待どおりに動作します。以下に例を示します:
/** ジェネリックコンポーネント */type SelectProps<T> = { items: T[] }class Select<T> extends React.Component<SelectProps<T>, any> { }/** 使い方 */const Form = () => <Select<string> items={['a','b']} />;
次のようなものがうまくいきます：
function foo<T>(x: T): T { return x; }
しかし、アロー関数のジェネリック関数を利用しようとすると、構文エラーになります。
const foo = <T>(x: T) => x; // ERROR : `T` タグが閉じられていません
回避策：ジェネリックのパラメータにextendsを使用すると、コンパイラがジェネリックであることを教えられます。extendsは、ジェネリックの型に制約を付けるためのキーワードです。{}をextendsする、ということは、オブジェクトであれば、何でも良い、ということです。なので、単に構文エラーを回避するために、このようにすることができます:
const foo = <T extends {}>(x: T) => x;
基本的にRefの変数をユニオン型で定義することによって、nullで初期化できます。そして、それをコンポーネントのrefプロパティに渡したコールバック関数で初期化できます。
class Example extends React.Component {example() {// ... 何らかの処理}render() { return <div>Foo</div> }}class Use {exampleRef: Example | null = null;render() {return <Example ref={exampleRef => this.exampleRef = exampleRef } />}}
これは、DOM要素の参照を保持する変数についても同じです。
class FocusingInput extends React.Component<{ value: string, onChange: (value: string) => any }, {}>{input: HTMLInputElement | null = null;render() {return (<inputref={(input) => this.input = input}value={this.props.value}onChange={(e) => { this.props.onChange(e.target.value) } }/>);}focus() {if (this.input != null) { this.input.focus() }}}
既に説明した のように、型アサーションにはas Foo構文を使います。
デフォルト値のあるPropsを持ったステートフルなコンポーネント： Nullアサーション演算子
?を使って、デフォルト値のあるPropsを定義できます。このPropsには、(外部からReactの仕組みによって)値が渡されます(これが最も理想的なものとは限りませんが、今思いつく限りでは、シンプルでミニマムなコードです)。
class Hello extends React.Component<{/*** @default 'TypeScript'*/compiler?: string,framework: string}> {static defaultProps = {compiler: 'TypeScript'}render() {const compiler = this.props.compiler!;return (<div><div>{compiler}</div><div>{this.props.framework}</div></div>);}}ReactDOM.render(<Hello framework="React" />, // TypeScript Reactdocument.getElementById("root"));
デフォルトPropsのあるFunctionコンポーネント ：シンプルなJavaScriptの構文を活用して、TypeScriptの型システムとうまく組み合わせることをお勧めします。下記はその例です:
const Hello: React.FC<{/*** @default 'TypeScript'*/compiler?: string,framework: string}> = ({compiler = 'TypeScript', // デフォルト値のあるPropsframework}) => {return (<div><div>{compiler}</div><div>{framework}</div></div>);};ReactDOM.render(<Hello framework="React" />, // TypeScript Reactdocument.getElementById("root"));
もしWebComponentを利用している場合、それはReactの型定義ファイル(@types/react)には定義されていません。しかし、アンビエント宣言(declare)を使って簡単に定義できます。例えば、my-awesome-sliderというWebComponentがあるとします。これは、MyAwesomeSliderPropsを受け取ります。この場合、以下のようになります:
declare global {namespace JSX {interface IntrinsicElements {'my-awesome-slider': MyAwesomeSliderProps;}interface MyAwesomeSliderProps extends React.Attributes {name: string;}}}
