Skip to content

Commit

Permalink
docs: link to info on attribute reflection in all component docs
Browse files Browse the repository at this point in the history 
PiperOrigin-RevId: 573010767
  • Loading branch information
@copybara-github
Extended Component Library Team authored and copybara-github committed Oct 12, 2023
1 parent 37edb99 commit 17bfc28
Show file tree
Hide file tree
Showing 21 changed files with 139 additions and 139 deletions.
2 changes: 1 addition & 1 deletion build/make_docs.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
18 changes: 9 additions & 9 deletions src/api_loader/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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).<br/><br/>React developers are encouraged to use the `apiKey` property instead, as `key` is a reserved word.<br/><br/>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).<br/><br/>React developers are encouraged to use the `apiKey` property instead, as `key` is a reserved word.<br/><br/>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

Expand Down
Loading

0 comments on commit 17bfc28

Please sign in to comment.