SPFx 1.20.0-rc.0

SP-Framework/sp-adaptive-card-extension-base.yml

@@ -11,16 +11,17 @@ classes:
   - '@microsoft/sp-adaptive-card-extension-base!BaseBasicCardView:class'
   - '@microsoft/sp-adaptive-card-extension-base!BaseCardView:class'
   - '@microsoft/sp-adaptive-card-extension-base!BaseComponentsCardView:class'
-  - '@microsoft/sp-adaptive-card-extension-base!BaseHTMLQuickView:class'
   - '@microsoft/sp-adaptive-card-extension-base!BaseImageCardView:class'
   - '@microsoft/sp-adaptive-card-extension-base!BasePrimaryTextCardView:class'
   - '@microsoft/sp-adaptive-card-extension-base!BaseQuickView:class'
   - '@microsoft/sp-adaptive-card-extension-base!BaseTemplateCardView:class'
   - '@microsoft/sp-adaptive-card-extension-base!BaseView:class'
+  - '@microsoft/sp-adaptive-card-extension-base!BaseWebQuickView:class'
   - '@microsoft/sp-adaptive-card-extension-base!QuickViewNavigator:class'
   - '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class'
 typeAliases:
   - '@microsoft/sp-adaptive-card-extension-base!BarChartData:type'
+  - '@microsoft/sp-adaptive-card-extension-base!BaseOnBeforeActionArguments:type'
   - '@microsoft/sp-adaptive-card-extension-base!CardComponentConfiguration:type'
   - '@microsoft/sp-adaptive-card-extension-base!CardComponentEventNames:type'
   - '@microsoft/sp-adaptive-card-extension-base!CardComponentName:type'
@@ -59,6 +60,7 @@ interfaces:
   - '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IBaseCardDataVisualizationParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!IBaseOnBeforeActionArguments:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IBaseSeries:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IBasicCardParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IBasicTextCardViewConfiguration:interface'
@@ -137,6 +139,7 @@ interfaces:
   - '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IShowCardActionArguments:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionArguments:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ISPFxAdaptiveCard:interface'
@@ -156,7 +159,7 @@ functions:
     package: '@microsoft/sp-adaptive-card-extension-base!'
     summary: Helper method to create a bar chart card view with numeric data.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: >-
@@ -176,7 +179,7 @@ functions:
     package: '@microsoft/sp-adaptive-card-extension-base!'
     summary: Helper method to create a bar chart card view with string data.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: >-
@@ -196,7 +199,7 @@ functions:
     package: '@microsoft/sp-adaptive-card-extension-base!'
     summary: Helper method to create a bar chart card view with date data.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: >-
@@ -288,7 +291,7 @@ functions:
     package: '@microsoft/sp-adaptive-card-extension-base!'
     summary: Helper method to create a pie chart card view
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: >-

SP-Framework/sp-adaptive-card-extension-base/barchartdata.yml

@@ -7,6 +7,6 @@ summary: Utility type to define what valid types of data can be used in a bar ch
 remarks: >-
   See [SupportedBarChartDataTypes](xref:@microsoft/sp-adaptive-card-extension-base!SupportedBarChartDataTypes:type) for
   valid types.
-isPreview: true
+isPreview: false
 isDeprecated: false
 syntax: 'export type BarChartData<Type> = ExtractFromSet<SupportedBarChartDataTypes, Type>;'

SP-Framework/sp-adaptive-card-extension-base/baseonbeforeactionarguments.yml

@@ -0,0 +1,15 @@
+### YamlMime:TSTypeAlias
+name: BaseOnBeforeActionArguments
+uid: '@microsoft/sp-adaptive-card-extension-base!BaseOnBeforeActionArguments:type'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: BaseOnBeforeActionArguments
+summary: >-
+  Base type to enforce correct type of arguments passed to
+  [BaseAdaptiveCardExtension.onBeforeAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23onBeforeAction:member(1))<!--
+  -->.
+remarks: ''
+isPreview: false
+isDeprecated: false
+syntax: >-
+  export type BaseOnBeforeActionArguments<T extends IBaseOnBeforeActionArguments> = IActionArguments | EnsureExtends<T,
+  IBaseOnBeforeActionArguments>;

SP-Framework/sp-adaptive-card-extension-base/basehtmlquickview.yml → SP-Framework/sp-adaptive-card-extension-base/basewebquickview.yml

@@ -1,36 +1,36 @@
 ### YamlMime:TSType
-name: BaseHTMLQuickView
-uid: '@microsoft/sp-adaptive-card-extension-base!BaseHTMLQuickView:class'
+name: BaseWebQuickView
+uid: '@microsoft/sp-adaptive-card-extension-base!BaseWebQuickView:class'
 package: '@microsoft/sp-adaptive-card-extension-base!'
-fullName: BaseHTMLQuickView
-summary: Base class for a HTML Quick view.
+fullName: BaseWebQuickView
+summary: Base class for a Web Quick view.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 type: class
 properties:
   - name: domElement
-    uid: '@microsoft/sp-adaptive-card-extension-base!BaseHTMLQuickView#domElement:member'
+    uid: '@microsoft/sp-adaptive-card-extension-base!BaseWebQuickView#domElement:member'
     package: '@microsoft/sp-adaptive-card-extension-base!'
     fullName: domElement
-    summary: DOM Element will be undefined in the constructor and after the quick view is disposed.
-    remarks: ''
-    isPreview: true
+    summary: Reference to the DOM element that hosts this quick view.
+    remarks: '- DOM element will be undefined in the constructor and after the quick view is disposed.'
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'protected get domElement(): HTMLDivElement;'
       return:
         type: HTMLDivElement
 methods:
   - name: dispose()
-    uid: '@microsoft/sp-adaptive-card-extension-base!BaseHTMLQuickView#dispose:member(1)'
+    uid: '@microsoft/sp-adaptive-card-extension-base!BaseWebQuickView#dispose:member(1)'
     package: '@microsoft/sp-adaptive-card-extension-base!'
     fullName: dispose()
-    summary: >-
-      This method is invoked when HTML Quick View's DOM element is removed from the Document. It will trigger when quick
-      view modal is closed, or navigating between quick views.
-    remarks: ''
-    isPreview: true
+    summary: Disposes the quick view.
+    remarks: >-
+      - This method is invoked when HTML Quick View's DOM element is removed from the Document. It will trigger when
+      quick view modal is closed, or navigating between quick views.
+    isPreview: false
     isDeprecated: false
     syntax:
       content: |-
@@ -40,12 +40,12 @@ methods:
         type: void
         description: ''
   - name: render()
-    uid: '@microsoft/sp-adaptive-card-extension-base!BaseHTMLQuickView#render:member(1)'
+    uid: '@microsoft/sp-adaptive-card-extension-base!BaseWebQuickView#render:member(1)'
     package: '@microsoft/sp-adaptive-card-extension-base!'
     fullName: render()
     summary: This API is called to render the HTML quick view. It will be invoked when opening this view.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: |-
@@ -55,12 +55,12 @@ methods:
         type: void
         description: ''
   - name: setState(newState)
-    uid: '@microsoft/sp-adaptive-card-extension-base!BaseHTMLQuickView#setState:member(1)'
+    uid: '@microsoft/sp-adaptive-card-extension-base!BaseWebQuickView#setState:member(1)'
     package: '@microsoft/sp-adaptive-card-extension-base!'
     fullName: setState(newState)
     summary: Update the state of the Adaptive Card Extension.
     remarks: '- This method will not trigger a re-render and only update the ACE with the new state.'
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'setState(newState?: Partial<TState> | undefined): void;'

SP-Framework/sp-adaptive-card-extension-base/ibarchartcardviewconfiguration.yml

@@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: IBarChartCardViewConfiguration
 summary: Configuration for a bar chart card view.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 type: interface
 properties:
@@ -15,7 +15,7 @@ properties:
     fullName: body
     summary: Body area components.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: >-

SP-Framework/sp-adaptive-card-extension-base/ibarchartseries.yml

@@ -8,7 +8,7 @@ remarks: >-
   The number of points rendered on the x-axis is predefined: - Large Chart: Limited to five points (displayed when a
   card view contains no more than three components). - Medium Chart: Limited to three points for a single series and two
   points for multiple series.
-isPreview: true
+isPreview: false
 isDeprecated: false
 type: interface
 properties:
@@ -18,7 +18,7 @@ properties:
     fullName: color
     summary: Color of the series.
     remarks: 'If not provided, a color will be automatically assigned.'
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'color?: string;'
@@ -30,7 +30,7 @@ properties:
     fullName: data
     summary: Data for the series.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'data: IDataPoint<T>[];'

SP-Framework/sp-adaptive-card-extension-base/ibaseonbeforeactionarguments.yml

@@ -0,0 +1,31 @@
+### YamlMime:TSType
+name: IBaseOnBeforeActionArguments
+uid: '@microsoft/sp-adaptive-card-extension-base!IBaseOnBeforeActionArguments:interface'
+package: '@microsoft/sp-adaptive-card-extension-base!'
+fullName: IBaseOnBeforeActionArguments
+summary: >-
+  Base object passed to
+  [BaseAdaptiveCardExtension.onBeforeAction()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23onBeforeAction:member(1))<!--
+  -->.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+  - name: id
+    uid: '@microsoft/sp-adaptive-card-extension-base!IBaseOnBeforeActionArguments#id:member'
+    package: '@microsoft/sp-adaptive-card-extension-base!'
+    fullName: id
+    summary: The id specified in the card view action or Adaptive Card template
+    remarks: >-
+      This ID is automatically set to -
+      [ICardButtonBase.id](xref:@microsoft/sp-adaptive-card-extension-base!ICardButtonBase%23id:member) if an action is
+      triggered by card view button -
+      [CARD\_VIEW\_SELECT\_ACTION\_ID](xref:@microsoft/sp-adaptive-card-extension-base!CARD_VIEW_SELECT_ACTION_ID:var)
+      if an action is triggered by card view select action - Action id if an action is triggered by Quick View
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'id?: string;'
+      return:
+        type: string

SP-Framework/sp-adaptive-card-extension-base/icardbarchartconfiguration.yml

@@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: ICardBarChartConfiguration
 summary: Configuration for a bar chart.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 type: interface
 extends: >-

SP-Framework/sp-adaptive-card-extension-base/icardbarchartparameters.yml

@@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: ICardBarChartParameters
 summary: Parameters for a bar chart.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 type: interface
 properties:
@@ -15,7 +15,7 @@ properties:
     fullName: dataVisualizationKind
     summary: Bar chart
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'dataVisualizationKind: ''bar'';'
@@ -27,7 +27,7 @@ properties:
     fullName: series
     summary: Series to display.
     remarks: Can be a single series or multiple (upto 3) series.
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'series: MaxThreeTuple<IBarChartSeries<T>>;'
@@ -41,7 +41,7 @@ properties:
     fullName: showDataLabels
     summary: Flag to indicate if data labels need to be shown or not.
     remarks: Default value is false
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'showDataLabels?: boolean;'

SP-Framework/sp-adaptive-card-extension-base/icardpiechartconfiguration.yml

@@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: ICardPieChartConfiguration
 summary: Configuration for a pie chart.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 type: interface
 extends: >-

SP-Framework/sp-adaptive-card-extension-base/icardpiechartparameters.yml

@@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: ICardPieChartParameters
 summary: Parameters for a pie chart.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 type: interface
 properties:
@@ -15,7 +15,7 @@ properties:
     fullName: dataVisualizationKind
     summary: Pie chart
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'dataVisualizationKind: ''pie'';'
@@ -27,7 +27,7 @@ properties:
     fullName: isDonut
     summary: Flag to indicate if the pie chart should be rendered as a donut chart.
     remarks: false by default. Renders as a donut chart if true.
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'isDonut?: boolean;'
@@ -39,7 +39,7 @@ properties:
     fullName: series
     summary: Series to display.
     remarks: Should be a single series.
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'series: [IPieChartSeries];'

SP-Framework/sp-adaptive-card-extension-base/iexternallinkactionarguments.yml

@@ -36,3 +36,4 @@ properties:
       content: 'url: string;'
       return:
         type: string
+extends: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IBaseOnBeforeActionArguments:interface" />'

SP-Framework/sp-adaptive-card-extension-base/ionbeforeactionarguments.yml

@@ -16,5 +16,5 @@ remarks: >-
 isPreview: false
 isDeprecated: false
 syntax: >-
-  export type IOnBeforeActionArguments = IActionArguments | IQuickViewActionArguments | IExternalLinkActionArguments |
-  IShowLocationCardAction;
+  export type IOnBeforeActionArguments = BaseOnBeforeActionArguments<IQuickViewActionArguments |
+  IExternalLinkActionArguments | IShowLocationActionArguments>;

SP-Framework/sp-adaptive-card-extension-base/ipiechartcardviewconfiguration.yml

@@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: IPieChartCardViewConfiguration
 summary: Configuration for a pie chart card view.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 type: interface
 properties:
@@ -15,7 +15,7 @@ properties:
     fullName: body
     summary: Body area components.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: >-

SP-Framework/sp-adaptive-card-extension-base/ipiechartseries.yml

@@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: IPieChartSeries
 summary: Series for a pie chart.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 type: interface
 properties:
@@ -22,7 +22,7 @@ properties:
 
 
       If the number of categories exceeds the limit, the excess categories will be grouped under 'Others'.
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'data: IPieDataPoint[];'