Skip to content

Commit 1aa7614

Browse files
jpoehneltjpoehnelt
authored
docs(README): add links for all attributes (#33)
1 parent 536d348 commit 1aa7614

File tree

5 files changed

+94
-88
lines changed

5 files changed

+94
-88
lines changed

‎.storybook/page.css

+6
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,10 @@
55
.sbdocs-wrapper {
66
min-height: fit-content !important;
77
padding: 1rem !important;
8+
}
9+
10+
a > code {
11+
color: #1a73e8 !important;
12+
font-weight: 600;
13+
text-decoration: none;
814
}

‎README.md

+34-34
Original file line numberDiff line numberDiff line change
@@ -180,31 +180,31 @@ by using the component attributes mapped to the corresponding methods of
180180

181181
#### Attributes
182182

183-
| Name | Type | Description |
184-
| ---------------- | ---------------------------- | --------------------------------------------------- |
185-
| `app-id` | `string` | The Google Drive app ID. |
186-
| `client-id` | `string` | The OAuth 2.0 client ID. |
187-
| `developer-key` | `string` | The API key for accessing Google Picker API. |
188-
| `hide-title-bar` | `"default"\|"true"\|"false"` | Hides the title bar of the picker if set to true. |
189-
| `locale` | `string` | The locale to use for the picker. |
190-
| `max-items` | `number` | The maximum number of items that can be selected. |
191-
| `mine-only` | `boolean` | If set to true, only shows files owned by the user. |
192-
| `multiselect` | `boolean` | Enables multiple file selection if set to true. |
193-
| `nav-hidden` | `boolean` | Hides the navigation pane if set to true. |
194-
| `oauth-token` | `string` | The OAuth 2.0 token for authentication. |
195-
| `origin` | `string` | The origin parameter for the picker. |
196-
| `relay-url` | `string` | The relay URL for the picker. |
197-
| `scope` | `string` | The OAuth 2.0 scope for the picker. |
198-
| `title` | `string` | The title of the picker. |
183+
| Name | Type | Description |
184+
| ---------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
185+
| `app-id` | `string` | The Google Drive app ID. See [`PickerBuilder.setAppId`](https://developers.google.com/drive/picker/reference/picker.pickerbuilder.setappid). |
186+
| `client-id` | `string` | The OAuth 2.0 client ID. See [Using OAuth 2.0 to Access Google APIs](https://developers.google.com/identity/protocols/oauth2). |
187+
| `developer-key` | `string` | The API key for accessing Google Picker API. See [`PickerBuilder.setDeveloperKey`](https://developers.google.com/drive/picker/reference/picker.pickerbuilder.setdeveloperkey). |
188+
| `hide-title-bar` | `"default"\|"true"\|"false"` | Hides the title bar of the picker if set to true. See [`PickerBuilder.hideTitleBar`](https://developers.google.com/drive/picker/reference/picker.pickerbuilder.hidetitlebar). |
189+
| `locale` | `string` | The locale to use for the picker. See [`PickerBuilder.setLocale`](https://developers.google.com/drive/picker/reference/picker.pickerbuilder.setlocale). |
190+
| `max-items` | `number` | The maximum number of items that can be selected. See [`PickerBuilder.setMaxItems`](https://developers.google.com/drive/picker/reference/picker.pickerbuilder.setmaxitems). |
191+
| `mine-only` | `boolean` | If set to true, only shows files owned by the user. See [`PickerBuilder.enableFeature`](https://developers.google.com/drive/picker/reference/picker.pickerbuilder.enablefeature). |
192+
| `multiselect` | `boolean` | Enables multiple file selection if set to true. See [`PickerBuilder.enableFeature`](https://developers.google.com/drive/picker/reference/picker.pickerbuilder.enablefeature). |
193+
| `nav-hidden` | `boolean` | Hides the navigation pane if set to true. See [`PickerBuilder.enableFeature`](https://developers.google.com/drive/picker/reference/picker.pickerbuilder.enablefeature). |
194+
| `oauth-token` | `string` | The OAuth 2.0 token for authentication. See [`PickerBuilder.setOAuthToken`](https://developers.google.com/drive/picker/reference/picker.pickerbuilder.setoauthtoken). |
195+
| `origin` | `string` | The origin parameter for the picker. See [`PickerBuilder.setOrigin`](https://developers.google.com/drive/picker/reference/picker.pickerbuilder.setorigin). |
196+
| `relay-url` | `string` | The relay URL for the picker. See [`PickerBuilder.setRelayUrl`](https://developers.google.com/drive/picker/reference/picker.pickerbuilder.setrelayurl). |
197+
| `scope` | `string` | The OAuth 2.0 scope for the picker. The default is `https://www.googleapis.com/auth/drive.file`. See [Drive API scopes](https://developers.google.com/drive/api/guides/api-specific-auth#drive-scopes). |
198+
| `title` | `string` | The title of the picker. See [`PickerBuilder.setTitle`](https://developers.google.com/drive/picker/reference/picker.pickerbuilder.settitle). |
199199

200200
#### Events
201201

202-
| Name | Type | Description |
203-
| ---------------------- | ------------------------------ | ---------------------------------------------------------------------------------- |
204-
| `picker:authenticated` | `{ token: string }` | Triggered when the user authenticates with the provided OAuth client ID and scope. |
205-
| `picker:canceled` | `google.picker.ResponseObject` | Triggered when the user cancels the picker dialog. |
206-
| `picker:picked` | `google.picker.ResponseObject` | Triggered when the user picks one or more items. |
207-
| `picker:error` | `google.picker.ResponseObject` | Triggered when an error occurs. |
202+
| Name | Type | Description |
203+
| ---------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
204+
| `picker:authenticated` | `{ token: string }` | Triggered when the user authenticates with the provided OAuth client ID and scope. |
205+
| `picker:canceled` | `google.picker.ResponseObject` | Triggered when the user cancels the picker dialog. See [`ResponseObject`](https://developers.google.com/drive/picker/reference/picker.responseobject). |
206+
| `picker:picked` | `google.picker.ResponseObject` | Triggered when the user picks one or more items. See [`ResponseObject`](https://developers.google.com/drive/picker/reference/picker.responseobject). |
207+
| `picker:error` | `google.picker.ResponseObject` | Triggered when an error occurs. See [`ResponseObject`](https://developers.google.com/drive/picker/reference/picker.responseobject). |
208208

209209
#### Slots
210210

@@ -224,18 +224,18 @@ The `drive-picker-docs-view` element is used to define a [`google.picker.DocsVie
224224

225225
#### Attributes
226226

227-
| Name | Type | Description |
228-
| ----------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------- |
229-
| `enable-drives` | `"default"\|"true"\|"false"` | Whether to allow the user to select files from shared drives. |
230-
| `include-folders` | `"default"\|"true"\|"false"` | Whether to include folders in the view. |
231-
| `mime-types` | `string` | A comma-separated list of MIME types to filter the view. |
232-
| `mode` | `string` | The mode of the view. |
233-
| `owned-by-me` | `"default"\|"true"\|"false"` | Whether to show files owned by the user. |
234-
| `parent` | `string` | The ID of the folder to view. |
235-
| `query` | `string` | The query string to filter the view. |
236-
| `select-folder-enabled` | `"default"\|"true"\|"false"` | Whether to allow the user to select folders. |
237-
| `starred` | `"default"\|"true"\|"false"` | Whether to show starred files. |
238-
| `view-id` | `string` | The `keyof typeof google.picker.ViewId`. For example, `"DOCS"`, which is equivalent to `google.picker.ViewId.DOCS`. |
227+
| Name | Type | Description |
228+
| ----------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
229+
| `enable-drives` | `"default"\|"true"\|"false"` | Whether to allow the user to select files from shared drives. See [`DocsView.enableDrives`](https://developers.google.com/drive/picker/reference/picker.docsview.setenabledrives). |
230+
| `include-folders` | `"default"\|"true"\|"false"` | Whether to include folders in the view. See [`DocsView.includeFolders`](https://developers.google.com/drive/picker/reference/picker.docsview.setincludefolders). |
231+
| `mime-types` | `string` | A comma-separated list of MIME types to filter the view. See [`View.setMimeTypes`](https://developers.google.com/drive/picker/reference/picker.view.setmimetypes). |
232+
| `mode` | `string` | The mode of the view. See [`DocsViewMode`](https://developers.google.com/drive/picker/reference/picker.docsviewmode). |
233+
| `owned-by-me` | `"default"\|"true"\|"false"` | Whether to show files owned by the user. See [`DocsView.ownedByMe`](https://developers.google.com/drive/picker/reference/picker.docsview.setownedbyme). |
234+
| `parent` | `string` | The ID of the folder to view. See [`DocsView.setParent`](https://developers.google.com/drive/picker/reference/picker.docsview.setparent). |
235+
| `query` | `string` | The query string to filter the view. See [`View.setQuery`](https://developers.google.com/drive/picker/reference/picker.view.setquery). |
236+
| `select-folder-enabled` | `"default"\|"true"\|"false"` | Whether to allow the user to select folders. See [`DocsView.selectFolderEnabled`](https://developers.google.com/drive/picker/reference/picker.docsview.setselectfolderenabled). |
237+
| `starred` | `"default"\|"true"\|"false"` | Whether to show starred files. See [`DocsView.starred`](https://developers.google.com/drive/picker/reference/picker.docsview.setstarred). |
238+
| `view-id` | `string` | The `keyof typeof google.picker.ViewId`. For example, `"DOCS"`, which is equivalent to `google.picker.ViewId.DOCS`. See [`ViewId`](https://developers.google.com/drive/picker/reference/picker.viewid). |
239239

240240
#### Properties
241241

0 commit comments

Comments
 (0)