From 755559fdd99e28aa9b9d70c51a7204f8244d16dd Mon Sep 17 00:00:00 2001 From: Mike Wilkerson <11575183+mlwilkerson@users.noreply.github.com> Date: Wed, 12 Feb 2025 16:50:30 -0800 Subject: [PATCH] auto-formatting --- .../src/components/fa-icon-chooser/readme.md | 29 +++++++++---------- .../src/components/fa-icon/readme.md | 9 +++--- 2 files changed, 17 insertions(+), 21 deletions(-) diff --git a/packages/fa-icon-chooser/src/components/fa-icon-chooser/readme.md b/packages/fa-icon-chooser/src/components/fa-icon-chooser/readme.md index 92418d7..657a98f 100644 --- a/packages/fa-icon-chooser/src/components/fa-icon-chooser/readme.md +++ b/packages/fa-icon-chooser/src/components/fa-icon-chooser/readme.md @@ -2,24 +2,21 @@ - ## 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` | `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, options?: object) => Promise` | `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` | `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, options?: object) => Promise` | `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. 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` | - +| 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. 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` | ## Slots @@ -42,7 +39,6 @@ | `"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 @@ -50,12 +46,13 @@ - [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/)_ diff --git a/packages/fa-icon-chooser/src/components/fa-icon/readme.md b/packages/fa-icon-chooser/src/components/fa-icon/readme.md index 3b0a68c..cfb28d4 100644 --- a/packages/fa-icon-chooser/src/components/fa-icon/readme.md +++ b/packages/fa-icon-chooser/src/components/fa-icon/readme.md @@ -8,7 +8,6 @@ may change as suits the needs of the Icon Chooser. - ## Overview 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. | `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/)_