|
| 1 | +--- |
| 2 | +name: Référence API |
| 3 | +description: ‘Apprenez en plus à propos de toutes les fonctions exporté Preact’ |
| 4 | +--- |
| 5 | + |
| 6 | +# Référence API |
| 7 | + |
| 8 | +Cette page sert de rapide vue d’ensemble de toutes les fonctions exportés. |
| 9 | + |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +<toc></toc> |
| 14 | + |
| 15 | +--- |
| 16 | + |
| 17 | +## Preact.Component |
| 18 | + |
| 19 | +Component est une classe de base dont vous allez généralement hériter afin de créer des composants Preact ayant leur propre état. |
| 20 | + |
| 21 | +### Component.render(props, state) |
| 22 | + |
| 23 | +Tous les composants doivent implémenter la fonction render(). Elle reçoit les propriétés et l'état du composant, et doit retourner un élément Preact ou null. |
| 24 | + |
| 25 | +```jsx |
| 26 | +import { Component } from 'preact'; |
| 27 | + |
| 28 | +class MyComponent extends Component { |
| 29 | + render(props, state) { |
| 30 | + // props === this.props |
| 31 | + // state === this.state |
| 32 | + |
| 33 | + return <h1>Bonjour, {props.name}!</h1>; |
| 34 | + } |
| 35 | +} |
| 36 | +``` |
| 37 | + |
| 38 | +Pour en apprendre d’avantage à propos des `Components` et comment ils peuvent être utilisé, visitez la page [Components](guide/v10/components). |
| 39 | + |
| 40 | +## render() |
| 41 | + |
| 42 | +`render(component, containerNode, [replaceNode])` |
| 43 | + |
| 44 | +Change un composant Preact en élément DOM `containerNode`. Retourne une référence à l'élément DOM rendu. |
| 45 | + |
| 46 | +Si le paramètre optionnel `replaceNode` est fourni avec un élément DOM et que celui-ci est un enfant de `containerNode`, Preact fera une mise-à-jour et remplacera cet élément |
| 47 | +en utilisant son algorithme de différenciation. |
| 48 | + |
| 49 | +```js |
| 50 | +import { render } from 'preact'; |
| 51 | + |
| 52 | +const Foo = () => <div>foo</div>; |
| 53 | + |
| 54 | +// DOM avant le rendu: |
| 55 | +// <div id="container"></div> |
| 56 | +render(<Foo />, document.getElementById('container')); |
| 57 | +// Après rendu: |
| 58 | +// <div id="container"> |
| 59 | +// <div>foo</div> |
| 60 | +// </div> |
| 61 | + |
| 62 | +// DOM avant rendu: |
| 63 | +// <div id="container"> |
| 64 | +// <div>bar</div> |
| 65 | +// <div id="target"></div> |
| 66 | +// </div> |
| 67 | +render( |
| 68 | + Foo, |
| 69 | + document.getElementById('container'), |
| 70 | + document.getElementById('target') |
| 71 | +); |
| 72 | +// Après rendu: |
| 73 | +// <div id="container"> |
| 74 | +// <div>bar</div> |
| 75 | +// <div id="target"> |
| 76 | +// <div>foo</div> |
| 77 | +// </div> |
| 78 | +// </div> |
| 79 | +``` |
| 80 | + |
| 81 | +## hydrate() |
| 82 | +Lorsque vous utilisez un DOM pré-rendu, il n'y a pas besoin de faire en rendu encore une fois. Avec `hydrate`, la plupart de la phase de différenciation sera sauté à l'exception des écoute d'évènements. C'est principalement utilisé en conjonction avec le rendu coté serveur (en anglais SSR : [Server-Side Rendering](/guide/v10/server-side-rendering)). |
| 83 | + |
| 84 | + |
| 85 | +```jsx |
| 86 | +import { render } from 'preact'; |
| 87 | + |
| 88 | +const Foo = () => <div>foo</div>; |
| 89 | +hydrate(<Foo />, document.getElementById('container)); |
| 90 | +``` |
| 91 | +
|
| 92 | +## h() / createElement() |
| 93 | +
|
| 94 | +`h(nodeName, attributes, [...children])` |
| 95 | +
|
| 96 | +Retourne un élément DOM virtuel Preact (en anglais : Preact Virtual DOM) avec les `attributes` donnés. |
| 97 | +
|
| 98 | +Les arguments suivant sont collectés dans une liste de `children` (enfants), et peuvent être : |
| 99 | +
|
| 100 | +- Une valeur scalaire (chaine de caractère, nombres, booléen, null, undefined, etc...) |
| 101 | +- D'autres éléments DOM virtuel |
| 102 | +- Une infinité de chaine imbriqués des éléments d'au dessus |
| 103 | +
|
| 104 | +```js |
| 105 | +import { h } from 'preact'; |
| 106 | +
|
| 107 | +h('div', { id: 'foo' }, 'Bonjour!'); |
| 108 | +// <div id="foo">Bonjour!</div> |
| 109 | +
|
| 110 | +h('div', { id: 'foo' }, 'Bonjour', null, ['Preact!']); |
| 111 | +// <div id="foo">Bonjour Preact!</div> |
| 112 | +
|
| 113 | +h( |
| 114 | + 'div', |
| 115 | + { id: 'foo' }, |
| 116 | + h('span', null, 'Bonjour!') |
| 117 | +); |
| 118 | +// <div id="foo"><span>Bonjour!</span></div> |
| 119 | +``` |
| 120 | +
|
| 121 | +## toChildArray |
| 122 | +
|
| 123 | +Cette fonction d'aide convertira toujours des enfants en liste. Si le paramètre est déjà une liste ceci ne fera rien. Cette fonction est nécéssaire parce que le paramètre `children` n'est pas garantis d'être une liste. |
| 124 | + |
| 125 | +Si un élément ne contient qu'un seul enfant, celui-ci le recevra directement. Ce n'est seulement lorsqu'il y a d'avantage d'enfants que vous pouvez être sûr que vous recevrez une liste. |
| 126 | +
|
| 127 | +Avec `toChildArray` vous pouvez vous assurer que ce sera toujours le cas. |
| 128 | +
|
| 129 | +```jsx |
| 130 | +import { toChildArray } from 'preact'; |
| 131 | +
|
| 132 | +function Foo(props) { |
| 133 | + const count = toChildArray(props.children).length; |
| 134 | + return <div>I have {count} children</div>; |
| 135 | +} |
| 136 | +
|
| 137 | +// children is not an array |
| 138 | +render(<Foo>bar</Foo>, container); |
| 139 | +
|
| 140 | +// Children is an array |
| 141 | +render(( |
| 142 | + <Foo> |
| 143 | + <p>A</p> |
| 144 | + <p>B</p> |
| 145 | + </Foo>, |
| 146 | + container |
| 147 | +); |
| 148 | +``` |
| 149 | +
|
| 150 | +## cloneElement |
| 151 | +
|
| 152 | +Cette fonction vous permet de faire un clone superficiel d'un composant et de faire le rendu du clone quelque part d'autre. |
| 153 | +
|
| 154 | +## createContext |
| 155 | +
|
| 156 | +Voir dans la section [Documentation context](/guide/v10/context#createcontext). |
| 157 | +
|
| 158 | +## createRef |
| 159 | +
|
| 160 | +Voir dans la section [Documentation références](/guide/v10/refs#createref). |
| 161 | +
|
| 162 | +## Fragment |
| 163 | +
|
| 164 | +Un type spécial de composant qui ne fait aucun rendu dans le DOM. Ils permettent à un composant de retourner multiple enfants sans avoir besoin de les emballer dans une balise div. |
| 165 | +
|
| 166 | +```jsx |
| 167 | +import { Fragment, render } from 'preact'; |
| 168 | +
|
| 169 | +render(( |
| 170 | + <Fragment> |
| 171 | + <div>A</div> |
| 172 | + <div>B</div> |
| 173 | + <div>C</div> |
| 174 | + </Fragment> |
| 175 | +), container); |
| 176 | +// Renders: |
| 177 | +// <div id="container> |
| 178 | +// <div>A</div> |
| 179 | +// <div>B</div> |
| 180 | +// <div>C</div> |
| 181 | +// </div> |
| 182 | +``` |
0 commit comments