You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The `fast-element` library is a lightweight means to easily build performant, memory-efficient, standards-compliant Web Components. FAST Elements work in every major browser and can be used in combination with any front-end framework or even without a framework.
177
-
178
-
## Installation
179
-
180
-
### From NPM
181
-
182
-
To install the `fast-element` library, use either `npm` or `yarn` as follows:
183
-
184
-
```shell
185
-
npm install --save @microsoft/fast-element
186
-
```
187
-
188
-
```shell
189
-
yarn add @microsoft/fast-element
190
-
```
191
-
192
-
Within your JavaScript or TypeScript code, you can then import library APIs like this:
193
-
194
-
```ts
195
-
import { FASTElement } from '@microsoft/fast-element';
196
-
```
197
-
198
-
:::tip
199
-
Looking for a setup that integrates with a particular front-end framework or bundler? Check out [our integration docs](../integrations/introduction.md).
200
-
:::
201
-
202
-
### From CDN
203
-
204
-
A pre-bundled script that contains all APIs needed to build web components with FAST Element is available on CDN. You can use this script by adding [`type="module"`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) to the script element and then importing from the CDN.
205
-
206
-
```html
207
-
<!DOCTYPE html>
208
-
<html lang="en">
209
-
<head>
210
-
<script type="module">
211
-
import { FASTElement } from "https://cdn.jsdelivr.net/npm/@microsoft/fast-element/dist/fast-element.min.js";
212
-
213
-
// your code here
214
-
</script>
215
-
</head>
216
-
<!-- ... -->
217
-
</html>
218
-
```
219
-
220
-
The markup above always references the latest release. When deploying to production, you will want to ship with a specific version. Here's an example of the markup for that:
For simplicity, examples throughout the documentation will assume the library has been installed from NPM, but you can always replace the import location with the CDN URL.
228
-
:::
229
-
230
-
:::tip
231
-
Looking for a quick guide on building components? Check out [our Cheat Sheet](../resources/cheat-sheet.md#building-components).
232
-
:::
233
-
=========================================
234
-
END OF @microsoft/fast-element NOTICES AND INFORMATION
235
-
236
-
%% @microsoft/fast-foundation NOTICES AND INFORMATION BEGIN HERE
The `fast-foundation` package is a library of Web Component classes, templates, and other utilities intended to be composed into registered Web Components by design systems (e.g. Fluent Design, Material Design, etc.). The exports of this package can generally be thought of as un-styled base components that implement semantic and accessible markup and behavior.
244
-
245
-
This package does not export Web Components registered as [custom elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) - it exports parts and pieces intended to be *composed* into Web Components, allowing you to implement your own design language by simply applying CSS styles and behaviors without having to write all the JavaScript that's involved in building production-quality component implementations.
246
-
247
-
## Installation
248
-
249
-
### From NPM
250
-
251
-
To install the `fast-foundation` library, use either `npm` or `yarn` as follows:
252
-
253
-
```shell
254
-
npm install --save @microsoft/fast-foundation
255
-
```
256
-
257
-
```shell
258
-
yarn add @microsoft/fast-foundation
259
-
```
260
-
261
-
Within your JavaScript or TypeScript code, you can then import library APIs like this:
262
-
263
-
```ts
264
-
import { Anchor } from '@microsoft/fast-foundation';
265
-
```
266
-
267
-
Looking for a setup that integrates with a particular front-end framework or bundler? Check out [our integration docs](https://fast.design/docs/integrations/introduction).
268
-
269
-
### From CDN
270
-
271
-
A pre-bundled script that contains all APIs needed to use FAST Foundation is available on CDN. You can use this script by adding [`type="module"`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) to the script element and then importing from the CDN.
272
-
273
-
```html
274
-
<!DOCTYPE html>
275
-
<html lang="en">
276
-
<head>
277
-
<script type="module">
278
-
import { Anchor } from "https://cdn.jsdelivr.net/npm/@microsoft/fast-foundation/dist/fast-foundation.min.js";
279
-
280
-
// your code here
281
-
</script>
282
-
</head>
283
-
<!-- ... -->
284
-
</html>
285
-
```
286
-
287
-
The markup above always references the latest release. When deploying to production, you will want to ship with a specific version. Here's an example of the markup for that:
For simplicity, examples throughout the documentation will assume the library has been installed from NPM, but you can always replace the import location with the CDN URL.
295
-
:::
296
-
=========================================
297
-
END OF @microsoft/fast-foundation NOTICES AND INFORMATION
298
-
299
-
%% @microsoft/fast-react-wrapper NOTICES AND INFORMATION BEGIN HERE
The `fast-react-wrapper` package contains a utility that enables automatically wrapping Web Components in a React component for ease of integration into React projects.
307
-
308
-
## Installation
309
-
310
-
### From NPM
311
-
312
-
To install the `fast-react-wrapper` library, use either `npm` or `yarn` as follows:
313
-
314
-
```shell
315
-
npm install --save @microsoft/fast-react-wrapper
316
-
```
317
-
318
-
```shell
319
-
yarn add @microsoft/fast-react-wrapper
320
-
```
321
-
322
-
Within your JavaScript or TypeScript code, you can then and use the wrapper like this:
323
-
324
-
```ts
325
-
import React from 'react';
326
-
import { provideReactWrapper } from '@microsoft/fast-react-wrapper';
327
-
328
-
const { wrap } = provideReactWrapper(React);
329
-
330
-
const MyComponent = wrap(MyComponent);
331
-
```
332
-
333
-
For additional wrapper settings and more information on integrating with Design Systems, see [our integration docs](https://fast.design/docs/integrations/react).
334
-
=========================================
335
-
END OF @microsoft/fast-react-wrapper NOTICES AND INFORMATION
336
-
337
164
%% @octokit/graphql NOTICES AND INFORMATION BEGIN HERE
338
165
=========================================
339
166
The MIT License
@@ -1876,32 +1703,6 @@ Creative Commons may be contacted at creativecommons.org.
1876
1703
=========================================
1877
1704
END OF @vscode/codicons NOTICES AND INFORMATION
1878
1705
1879
-
%% @vscode/webview-ui-toolkit NOTICES AND INFORMATION BEGIN HERE
1880
-
=========================================
1881
-
Copyright (c) Microsoft Corporation.
1882
-
1883
-
MIT License
1884
-
1885
-
Permission is hereby granted, free of charge, to any person obtaining a copy
1886
-
of this software and associated documentation files (the "Software"), to deal
1887
-
in the Software without restriction, including without limitation the rights
1888
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
1889
-
copies of the Software, and to permit persons to whom the Software is
1890
-
furnished to do so, subject to the following conditions:
1891
-
1892
-
The above copyright notice and this permission notice shall be included in all
1893
-
copies or substantial portions of the Software.
1894
-
1895
-
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1896
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
1897
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1898
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1899
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
1900
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1901
-
SOFTWARE.
1902
-
=========================================
1903
-
END OF @vscode/webview-ui-toolkit NOTICES AND INFORMATION
1904
-
1905
1706
%% ansi-regex NOTICES AND INFORMATION BEGIN HERE
1906
1707
=========================================
1907
1708
MIT License
@@ -2414,21 +2215,4 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2414
2215
SOFTWARE.
2415
2216
2416
2217
=========================================
2417
-
END OF sortablejs NOTICES AND INFORMATION
2418
-
2419
-
%% tslib NOTICES AND INFORMATION BEGIN HERE
2420
-
=========================================
2421
-
Copyright (c) Microsoft Corporation.
2422
-
2423
-
Permission to use, copy, modify, and/or distribute this software for any
2424
-
purpose with or without fee is hereby granted.
2425
-
2426
-
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
2427
-
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
2428
-
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
2429
-
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
2430
-
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
2431
-
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
0 commit comments