Skip to content

Commit

Permalink
auto-formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@mlwilkerson
mlwilkerson committed Jun 5, 2024
1 parent 0edf7a4 commit b7b4e1b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 18 deletions.
23 changes: 10 additions & 13 deletions packages/fa-icon-chooser/src/components/fa-icon-chooser/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,22 @@

<!-- Auto Generated Below -->


## Properties

| Property | Attribute | Description | Type | Default |
| ------------------------ | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | ----------- |
| `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` |
| `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) => Promise<any>` | `undefined` |
| `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` |
| `searchInputPlaceholder` | `search-input-placeholder` | Placeholder text for search form. Use this to provide translatable text. | `string` | `undefined` |
| `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` |

| Property | Attribute | Description | Type | Default |
| ------------------------ | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------- | ----------- |
| `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` |
| `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) => Promise<any>` | `undefined` |
| `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` |
| `searchInputPlaceholder` | `search-input-placeholder` | Placeholder text for search form. Use this to provide translatable text. | `string` | `undefined` |
| `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` |

## Events

| Event | Description | Type |
| -------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------- |
| `finish` | Clients of the Icon Chooser should listen for this event in order to handle the result of the user's interaction. | `CustomEvent<IconLookup>` |


## Slots

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


## Dependencies

### Depends on

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

### Graph

```mermaid
graph TD;
fa-icon-chooser --> fa-icon
style fa-icon-chooser fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------
---

*Built with [StencilJS](https://stenciljs.com/)*
_Built with [StencilJS](https://stenciljs.com/)_
9 changes: 4 additions & 5 deletions packages/fa-icon-chooser/src/components/fa-icon/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ may change as suits the needs of the Icon Chooser.

<!-- Auto Generated Below -->


## Properties

| Property | Attribute | Description | Type | Default |
Expand All @@ -26,20 +25,20 @@ may change as suits the needs of the Icon Chooser.
| `svgApi` | `svg-api` | | `any` | `undefined` |
| `svgFetchBaseUrl` | `svg-fetch-base-url` | | `string` | `undefined` |


## Dependencies

### Used by

- [fa-icon-chooser](../fa-icon-chooser)
- [fa-icon-chooser](../fa-icon-chooser)

### Graph

```mermaid
graph TD;
fa-icon-chooser --> fa-icon
style fa-icon fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------
---

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

0 comments on commit b7b4e1b

Please sign in to comment.