Skip to content

Commit b2d3ee7

Browse files
committed
Add picker references and update picker docs
1 parent 1d35a2d commit b2d3ee7

File tree

4 files changed

+16
-4
lines changed

4 files changed

+16
-4
lines changed

packages/ui-extensions/src/surfaces/admin/api/action/action.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import type {StandardApi} from '../standard/standard';
22
import type {ExtensionTarget as AnyExtensionTarget} from '../../extension-targets';
33
import type {Data} from '../shared';
44
import type {ResourcePickerApi} from '../resource-picker/resource-picker';
5+
import type {PickerApi} from '../picker/picker';
56

67
export interface ActionExtensionApi<ExtensionTarget extends AnyExtensionTarget>
78
extends StandardApi<ExtensionTarget> {
@@ -16,7 +17,12 @@ export interface ActionExtensionApi<ExtensionTarget extends AnyExtensionTarget>
1617
data: Data;
1718

1819
/**
19-
* Renders the [Resource Picker](/docs/api/app-bridge-library/apis/resource-picker), allowing users to select a resource for the extension to use as part of its flow.
20+
* Renders the [Resource Picker](resource-picker), allowing users to select a resource for the extension to use as part of its flow.
2021
*/
2122
resourcePicker: ResourcePickerApi;
23+
24+
/**
25+
* Renders a custom [Picker](picker) dialog allowing users to select values from a list.
26+
*/
27+
picker: PickerApi;
2228
}

packages/ui-extensions/src/surfaces/admin/api/picker/picker.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ const data: ReferenceEntityTemplateSchema = {
1111
category: 'API',
1212
thumbnail: 'picker.png',
1313
requires:
14-
'an [Admin block extension](/docs/api/admin-extensions/unstable/extension-targets#block-locations)',
14+
'an Admin [block](/docs/api/admin-extensions/unstable/extension-targets#block-locations), [action](/docs/api/admin-extensions/unstable/extension-targets#action-locations), or [print](/docs/api/admin-extensions/unstable/extension-targets#print-locations) extension.',
1515
defaultExample: {
1616
image: 'picker.png',
1717
codeblock: {

packages/ui-extensions/src/surfaces/admin/api/print-action/print-action.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import type {StandardApi} from '../standard/standard';
22
import type {ExtensionTarget as AnyExtensionTarget} from '../../extension-targets';
33
import type {Data} from '../shared';
44
import type {ResourcePickerApi} from '../resource-picker/resource-picker';
5+
import type {PickerApi} from '../picker/picker';
56

67
export interface PrintActionExtensionApi<
78
ExtensionTarget extends AnyExtensionTarget,
@@ -12,7 +13,12 @@ export interface PrintActionExtensionApi<
1213
data: Data;
1314

1415
/**
15-
* Renders the [Resource Picker](/docs/api/app-bridge-library/apis/resource-picker), allowing users to select a resource for the extension to use as part of its flow.
16+
* Renders the [Resource Picker](resource-picker), allowing users to select a resource for the extension to use as part of its flow.
1617
*/
1718
resourcePicker: ResourcePickerApi;
19+
20+
/**
21+
* Renders a custom [Picker](picker) dialog allowing users to select values from a list.
22+
*/
23+
picker: PickerApi;
1824
}

packages/ui-extensions/src/surfaces/admin/api/resource-picker/resource-picker.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const data: ReferenceEntityTemplateSchema = {
1212
category: 'API',
1313
thumbnail: 'resource-picker.png',
1414
requires:
15-
'an [Admin block extension](/docs/api/admin-extensions/unstable/extension-targets#block-locations)',
15+
'an Admin [block](/docs/api/admin-extensions/unstable/extension-targets#block-locations), [action](/docs/api/admin-extensions/unstable/extension-targets#action-locations), or [print](/docs/api/admin-extensions/unstable/extension-targets#print-locations) extension.',
1616
defaultExample: {
1717
image: 'resource-picker.png',
1818
codeblock: {

0 commit comments

Comments
 (0)