diff --git a/build/make_docs.js b/build/make_docs.js index 740e9db..29bd4f0 100644 --- a/build/make_docs.js +++ b/build/make_docs.js @@ -403,7 +403,7 @@ function declarationToMarkdown(declaration, module, headerLevel) { 'Property type', 'Description', 'Default', - 'Reflects?', + '[Reflects?](https://open-wc.org/guides/knowledge/attributes-and-properties/#attribute-and-property-reflection)', ], ]; for (const field of fields) { diff --git a/src/api_loader/README.md b/src/api_loader/README.md index 20d21e6..8f61ca6 100644 --- a/src/api_loader/README.md +++ b/src/api_loader/README.md @@ -33,15 +33,15 @@ import { APILoader } from '@googlemaps/extended-component-library/api_loader.js' ## Attributes and properties -| Attribute | Property | Property type | Description | Default | Reflects? | -| ---------------------- | -------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | --------- | -| | `apiKey` | `string\|undefined` | An alias for the `key` property. React developers should use this prop to set the API key. | | ❌ | -| `auth-referrer-policy` | `authReferrerPolicy` | `string \| undefined` | Maps JS customers can configure HTTP Referrer Restrictions in the Cloud Console to limit which URLs are allowed to use a particular API Key. This parameter can limit the amount of data sent to Google Maps when evaluating HTTP Referrer Restrictions. Please see the [documentation](https://developers.google.com/maps/documentation/javascript/dynamic-loading?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components#optional_parameters) for more information. | | ✅ | -| `key` | `key` | `string \| undefined` | (Required) A valid Google Maps Platform API key. If you don't have one already [sign up for Google Maps Platform and create an API key](https://console.cloud.google.com/google/maps-apis/start?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components).

React developers are encouraged to use the `apiKey` property instead, as `key` is a reserved word.

You can learn more about API keys in the Google Maps Platform [documentation](https://developers.google.com/maps/documentation/javascript/get-api-key?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components). | | ✅ | -| `language` | `language` | `string \| undefined` | The language code; defaults to the user's preferred language setting as specified in the browser when displaying textual information. Read [more on localization](https://developers.google.com/maps/documentation/javascript/localization?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components). | | ✅ | -| `region` | `region` | `string \| undefined` | The region code to use. This alters the map's behavior based on a given country or territory. Read [more on region codes](https://developers.google.com/maps/documentation/javascript/localization?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components#Region). | | ✅ | -| `solution-channel` | `solutionChannel` | `string \| undefined` | To understand usage and ways to improve our solutions, Google includes the `solution_channel` query parameter in API calls to gather information about code usage. You may opt out at any time by setting this attribute to an empty string. Read more in the [documentation](https://developers.google.com/maps/reporting-and-monitoring/reporting?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components#solutions-usage). | | ✅ | -| `version` | `version` | `string` | The release channel or version numbers. See the [documentation](https://developers.google.com/maps/documentation/javascript/versions?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components) for more information. | `'beta'` | ✅ | +| Attribute | Property | Property type | Description | Default | [Reflects?](https://open-wc.org/guides/knowledge/attributes-and-properties/#attribute-and-property-reflection) | +| ---------------------- | -------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | -------------------------------------------------------------------------------------------------------------- | +| | `apiKey` | `string\|undefined` | An alias for the `key` property. React developers should use this prop to set the API key. | | ❌ | +| `auth-referrer-policy` | `authReferrerPolicy` | `string \| undefined` | Maps JS customers can configure HTTP Referrer Restrictions in the Cloud Console to limit which URLs are allowed to use a particular API Key. This parameter can limit the amount of data sent to Google Maps when evaluating HTTP Referrer Restrictions. Please see the [documentation](https://developers.google.com/maps/documentation/javascript/dynamic-loading?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components#optional_parameters) for more information. | | ✅ | +| `key` | `key` | `string \| undefined` | (Required) A valid Google Maps Platform API key. If you don't have one already [sign up for Google Maps Platform and create an API key](https://console.cloud.google.com/google/maps-apis/start?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components).

React developers are encouraged to use the `apiKey` property instead, as `key` is a reserved word.

You can learn more about API keys in the Google Maps Platform [documentation](https://developers.google.com/maps/documentation/javascript/get-api-key?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components). | | ✅ | +| `language` | `language` | `string \| undefined` | The language code; defaults to the user's preferred language setting as specified in the browser when displaying textual information. Read [more on localization](https://developers.google.com/maps/documentation/javascript/localization?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components). | | ✅ | +| `region` | `region` | `string \| undefined` | The region code to use. This alters the map's behavior based on a given country or territory. Read [more on region codes](https://developers.google.com/maps/documentation/javascript/localization?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components#Region). | | ✅ | +| `solution-channel` | `solutionChannel` | `string \| undefined` | To understand usage and ways to improve our solutions, Google includes the `solution_channel` query parameter in API calls to gather information about code usage. You may opt out at any time by setting this attribute to an empty string. Read more in the [documentation](https://developers.google.com/maps/reporting-and-monitoring/reporting?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components#solutions-usage). | | ✅ | +| `version` | `version` | `string` | The release channel or version numbers. See the [documentation](https://developers.google.com/maps/documentation/javascript/versions?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components) for more information. | `'beta'` | ✅ | ## Methods diff --git a/src/icon_button/README.md b/src/icon_button/README.md index 6086443..ee9f223 100644 --- a/src/icon_button/README.md +++ b/src/icon_button/README.md @@ -31,14 +31,14 @@ import { IconButton } from '@googlemaps/extended-component-library/icon_button.j ## Attributes and properties -| Attribute | Property | Property type | Description | Default | Reflects? | -| --------------- | -------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------- | -| `aria-haspopup` | `ariaHasPopup` | `'true'\|'dialog'\|'menu'\|'listbox'\|'tree'\|'grid'\| 'false'` | Indicates the availability and type of interactive popup element that can be triggered by the button. See: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-haspopup.

This attribute has no effect when `href` is set. | `'false'` | ✅ | -| `aria-label` | `ariaLabel` | `string\|null` | A description that gets read by assistive devices. In the case of icon-only buttons, you should always include an ARIA label for optimal accessibility. | `null` | ✅ | -| `condensed` | `condensed` | `boolean` | Whether to render the button in a condensed layout, where the label appears below the icon. | `false` | ✅ | -| `href` | `href` | `string \| undefined` | Set this attribute to a URL to have the Icon Button open it in a new tab, when clicked. Alternatively, specify on-click behavior for this component by attaching an event listener.

Per accessibility best practice, the component will render its content inside an `` instead of `