Skip to content

Commit e5dd40c

Browse files
mlwilkersonmlwilkerson
committed
auto-formatting
1 parent a8b4081 commit e5dd40c

File tree

2 files changed

+17
-21
lines changed

2 files changed

+17
-21
lines changed

‎packages/fa-icon-chooser/src/components/fa-icon-chooser/readme.md‎

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,21 @@
22

33
<!-- Auto Generated Below -->
44

5-
65
## Properties
76

8-
| Property | Attribute | Description | Type | Default |
9-
| ------------------------ | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----------- |
10-
| `getUrlText` | -- | Callback function that returns the text body of a response that corresponds to an HTTP GET request for the given URL. For example, it would be the result of [Response.text()](https://developer.mozilla.org/en-US/docs/Web/API/Response/text). | `(url: string) => Promise<string>` | `undefined` |
11-
| `handleQuery` | -- | Required callback function which is responsible for taking a given GraphQL query document and returns a Promise that resolves to a JavaScript object corresponding to the body of the associated network request, same as what would be produced by [Response.json()](https://developer.mozilla.org/en-US/docs/Web/API/Response/json). The query document is compliant with the GraphQL API at [api.fontawesome.com](https://fontawesome.com/v5.15/how-to-use/graphql-api/intro/getting-started). The implementation is responsible for handling any authorization that may be necessary to fulfill the request. For example, any time a kit is used to drive the Icon Chooser, it will be necessary to authorize GraphQL API requests sent to api.fontawesome.com with the [`kits_read` scope](https://fontawesome.com/v5.15/how-to-use/graphql-api/auth/scopes). | `(document: string, variables?: object, options?: object) => Promise<any>` | `undefined` |
12-
| `kitToken` | `kit-token` | A kit token identifying a kit in which to find icons. Takes precedent over version prop if both are present. | `string` | `undefined` |
13-
| `searchInputPlaceholder` | `search-input-placeholder` | Placeholder text for search form. Use this to provide translatable text. | `string` | `undefined` |
14-
| `version` | `version` | Version to use for finding and loading icons when kitToken is not provided. Must be a valid semantic version, as parsed by the [semver NPM](https://www.npmjs.com/package/semver), like 5.5.13 or 6.0.0-beta1. | `string` | `undefined` |
15-
7+
| Property | Attribute | Description | Type | Default |
8+
| ------------------------ | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | ----------- |
9+
| `getUrlText` | -- | Callback function that returns the text body of a response that corresponds to an HTTP GET request for the given URL. For example, it would be the result of [Response.text()](https://developer.mozilla.org/en-US/docs/Web/API/Response/text). | `(url: string) => Promise<string>` | `undefined` |
10+
| `handleQuery` | -- | Required callback function which is responsible for taking a given GraphQL query document and returns a Promise that resolves to a JavaScript object corresponding to the body of the associated network request, same as what would be produced by [Response.json()](https://developer.mozilla.org/en-US/docs/Web/API/Response/json). The query document is compliant with the GraphQL API at [api.fontawesome.com](https://fontawesome.com/v5.15/how-to-use/graphql-api/intro/getting-started). The implementation is responsible for handling any authorization that may be necessary to fulfill the request. For example, any time a kit is used to drive the Icon Chooser, it will be necessary to authorize GraphQL API requests sent to api.fontawesome.com with the [`kits_read` scope](https://fontawesome.com/v5.15/how-to-use/graphql-api/auth/scopes). | `(document: string, variables?: object, options?: object) => Promise<any>` | `undefined` |
11+
| `kitToken` | `kit-token` | A kit token identifying a kit in which to find icons. Takes precedent over version prop if both are present. | `string` | `undefined` |
12+
| `searchInputPlaceholder` | `search-input-placeholder` | Placeholder text for search form. Use this to provide translatable text. | `string` | `undefined` |
13+
| `version` | `version` | Version to use for finding and loading icons when kitToken is not provided. Must be a valid semantic version, as parsed by the [semver NPM](https://www.npmjs.com/package/semver), like 5.5.13 or 6.0.0-beta1. | `string` | `undefined` |
1614

1715
## Events
1816

19-
| Event | Description | Type |
20-
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
21-
| `finish` | Clients of the Icon Chooser should listen for this event in order to handle the result of the user's interaction. The emitted `IconChooserResult` will not include SVG data (as an `IconDefinition`) when prohibited by the client's license. License terms for SVG icon data emitted are governed by the terms on the Font Awesome [plans page](https://fontawesome.com/plans), which are elaborated on the Font Awesome [support page](https://fontawesome.com/support). | `CustomEvent<IconDefinition \| IconLookup>` |
22-
17+
| Event | Description | Type |
18+
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
19+
| `finish` | Clients of the Icon Chooser should listen for this event in order to handle the result of the user's interaction. The emitted `IconChooserResult` will not include SVG data (as an `IconDefinition`) when prohibited by the client's license. License terms for SVG icon data emitted are governed by the terms on the Font Awesome [plans page](https://fontawesome.com/plans), which are elaborated on the Font Awesome [support page](https://fontawesome.com/support). | `CustomEvent<IconDefinition \| IconLookup>` |
2320

2421
## Slots
2522

@@ -42,20 +39,20 @@
4239
| `"start-view-heading"` | heading for message on default view before search |
4340
| `"suggest-icon-upload"` | message suggesting to try uploading a custom icon to a kit |
4441

45-
4642
## Dependencies
4743

4844
### Depends on
4945

5046
- [fa-icon](../fa-icon)
5147

5248
### Graph
49+
5350
```mermaid
5451
graph TD;
5552
fa-icon-chooser --> fa-icon
5653
style fa-icon-chooser fill:#f9f,stroke:#333,stroke-width:4px
5754
```
5855

59-
----------------------------------------------
56+
---
6057

61-
*Built with [StencilJS](https://stenciljs.com/)*
58+
_Built with [StencilJS](https://stenciljs.com/)_

‎packages/fa-icon-chooser/src/components/fa-icon/readme.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ may change as suits the needs of the Icon Chooser.
88

99
<!-- Auto Generated Below -->
1010

11-
1211
## Overview
1312

1413
This fa-icon component isn't THE fa-icon component. It's just a convenience
@@ -32,20 +31,20 @@ component to help with displaying icons within the Icon Chooser.
3231
| `svgApi` | `svg-api` | | `any` | `undefined` |
3332
| `svgFetchBaseUrl` | `svg-fetch-base-url` | | `string` | `undefined` |
3433

35-
3634
## Dependencies
3735

3836
### Used by
3937

40-
- [fa-icon-chooser](../fa-icon-chooser)
38+
- [fa-icon-chooser](../fa-icon-chooser)
4139

4240
### Graph
41+
4342
```mermaid
4443
graph TD;
4544
fa-icon-chooser --> fa-icon
4645
style fa-icon fill:#f9f,stroke:#333,stroke-width:4px
4746
```
4847

49-
----------------------------------------------
48+
---
5049

51-
*Built with [StencilJS](https://stenciljs.com/)*
50+
_Built with [StencilJS](https://stenciljs.com/)_

0 commit comments

Comments
 (0)