Skip to content

SPFx 1.20.0-beta.0 #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 90 additions & 0 deletions SP-Framework/sp-adaptive-card-extension-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ 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'
Expand All @@ -19,6 +20,7 @@ classes:
- '@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!CardComponentConfiguration:type'
- '@microsoft/sp-adaptive-card-extension-base!CardComponentEventNames:type'
- '@microsoft/sp-adaptive-card-extension-base!CardComponentName:type'
Expand All @@ -40,6 +42,7 @@ typeAliases:
- '@microsoft/sp-adaptive-card-extension-base!LineChartData:type'
- '@microsoft/sp-adaptive-card-extension-base!MaxThreeTuple:type'
- '@microsoft/sp-adaptive-card-extension-base!RenderType:type'
- '@microsoft/sp-adaptive-card-extension-base!SupportedBarChartDataTypes:type'
- '@microsoft/sp-adaptive-card-extension-base!SupportedLineChartDataTypes:type'
interfaces:
- '@microsoft/sp-adaptive-card-extension-base!IActionError:interface'
Expand All @@ -50,6 +53,8 @@ interfaces:
- '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionPropertyMetadata:interface'
- '@microsoft/sp-adaptive-card-extension-base!IAttachmentError:interface'
- '@microsoft/sp-adaptive-card-extension-base!IAxis:interface'
- '@microsoft/sp-adaptive-card-extension-base!IBarChartCardViewConfiguration:interface'
- '@microsoft/sp-adaptive-card-extension-base!IBarChartSeries:interface'
- '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments:interface'
- '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments:interface'
- '@microsoft/sp-adaptive-card-extension-base!IBaseCardDataVisualizationParameters:interface'
Expand All @@ -59,6 +64,8 @@ interfaces:
- '@microsoft/sp-adaptive-card-extension-base!IBasicTextCardViewConfiguration:interface'
- '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters:interface'
- '@microsoft/sp-adaptive-card-extension-base!ICacheSettings:interface'
- '@microsoft/sp-adaptive-card-extension-base!ICardBarChartConfiguration:interface'
- '@microsoft/sp-adaptive-card-extension-base!ICardBarChartParameters:interface'
- '@microsoft/sp-adaptive-card-extension-base!ICardBarConfiguration:interface'
- '@microsoft/sp-adaptive-card-extension-base!ICardBarParameters:interface'
- '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface'
Expand All @@ -68,6 +75,8 @@ interfaces:
- '@microsoft/sp-adaptive-card-extension-base!ICardComponentParameters:interface'
- '@microsoft/sp-adaptive-card-extension-base!ICardLineChartConfiguration:interface'
- '@microsoft/sp-adaptive-card-extension-base!ICardLineChartParameters:interface'
- '@microsoft/sp-adaptive-card-extension-base!ICardPieChartConfiguration:interface'
- '@microsoft/sp-adaptive-card-extension-base!ICardPieChartParameters:interface'
- '@microsoft/sp-adaptive-card-extension-base!ICardSearchBoxButton:interface'
- '@microsoft/sp-adaptive-card-extension-base!ICardSearchBoxConfiguration:interface'
- '@microsoft/sp-adaptive-card-extension-base!ICardSearchBoxParameters:interface'
Expand Down Expand Up @@ -109,6 +118,9 @@ interfaces:
- '@microsoft/sp-adaptive-card-extension-base!IPartialSDKs:interface'
- '@microsoft/sp-adaptive-card-extension-base!IPartialTeamsContext:interface'
- '@microsoft/sp-adaptive-card-extension-base!IPartialTeamsJs:interface'
- '@microsoft/sp-adaptive-card-extension-base!IPieChartCardViewConfiguration:interface'
- '@microsoft/sp-adaptive-card-extension-base!IPieChartSeries:interface'
- '@microsoft/sp-adaptive-card-extension-base!IPieDataPoint:interface'
- '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface'
- '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardViewConfiguration:interface'
- '@microsoft/sp-adaptive-card-extension-base!IQuickViewActionArguments:interface'
Expand Down Expand Up @@ -139,6 +151,66 @@ interfaces:
enums:
- '@microsoft/sp-adaptive-card-extension-base!MediaType:enum'
functions:
- name: BarChartCardView(configuration)
uid: '@microsoft/sp-adaptive-card-extension-base!BarChartCardView:function(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
summary: Helper method to create a bar chart card view with numeric data.
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: >-
export declare function BarChartCardView(configuration: IBarChartCardViewConfiguration<number>):
IDataVisualizationCardViewParameters;
parameters:
- id: configuration
description: ''
type: >-
<xref uid="@microsoft/sp-adaptive-card-extension-base!IBarChartCardViewConfiguration:interface"
/>&lt;number&gt;
return:
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewParameters:interface" />'
description: ''
- name: BarChartCardView(configuration)
uid: '@microsoft/sp-adaptive-card-extension-base!BarChartCardView:function(2)'
package: '@microsoft/sp-adaptive-card-extension-base!'
summary: Helper method to create a bar chart card view with string data.
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: >-
export declare function BarChartCardView(configuration: IBarChartCardViewConfiguration<string>):
IDataVisualizationCardViewParameters;
parameters:
- id: configuration
description: ''
type: >-
<xref uid="@microsoft/sp-adaptive-card-extension-base!IBarChartCardViewConfiguration:interface"
/>&lt;string&gt;
return:
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewParameters:interface" />'
description: ''
- name: BarChartCardView(configuration)
uid: '@microsoft/sp-adaptive-card-extension-base!BarChartCardView:function(3)'
package: '@microsoft/sp-adaptive-card-extension-base!'
summary: Helper method to create a bar chart card view with date data.
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: >-
export declare function BarChartCardView(configuration: IBarChartCardViewConfiguration<Date>):
IDataVisualizationCardViewParameters;
parameters:
- id: configuration
description: ''
type: >-
<xref uid="@microsoft/sp-adaptive-card-extension-base!IBarChartCardViewConfiguration:interface"
/>&lt;Date&gt;
return:
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewParameters:interface" />'
description: ''
- name: BasicCardView(configuration)
uid: '@microsoft/sp-adaptive-card-extension-base!BasicCardView:function(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
Expand Down Expand Up @@ -211,6 +283,24 @@ functions:
return:
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewParameters:interface" />'
description: ''
- name: PieChartCardView(configuration)
uid: '@microsoft/sp-adaptive-card-extension-base!PieChartCardView:function(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
summary: Helper method to create a pie chart card view
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: >-
export declare function PieChartCardView(configuration: IPieChartCardViewConfiguration):
IDataVisualizationCardViewParameters;
parameters:
- id: configuration
description: pie chart card view configuration.
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IPieChartCardViewConfiguration:interface" />'
return:
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewParameters:interface" />'
description: pie chart card view parameters.
- name: PrimaryTextCardView(configuration)
uid: '@microsoft/sp-adaptive-card-extension-base!PrimaryTextCardView:function(1)'
package: '@microsoft/sp-adaptive-card-extension-base!'
Expand Down
12 changes: 12 additions & 0 deletions SP-Framework/sp-adaptive-card-extension-base/barchartdata.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### YamlMime:TSTypeAlias
name: BarChartData
uid: '@microsoft/sp-adaptive-card-extension-base!BarChartData:type'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: BarChartData
summary: Utility type to define what valid types of data can be used in a bar chart data visualization.
remarks: >-
See [SupportedBarChartDataTypes](xref:@microsoft/sp-adaptive-card-extension-base!SupportedBarChartDataTypes:type) for
valid types.
isPreview: true
isDeprecated: false
syntax: 'export type BarChartData<Type> = ExtractFromSet<SupportedBarChartDataTypes, Type>;'
74 changes: 74 additions & 0 deletions SP-Framework/sp-adaptive-card-extension-base/basehtmlquickview.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
### YamlMime:TSType
name: BaseHTMLQuickView
uid: '@microsoft/sp-adaptive-card-extension-base!BaseHTMLQuickView:class'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: BaseHTMLQuickView
summary: Base class for a HTML Quick view.
remarks: ''
isPreview: true
isDeprecated: false
type: class
properties:
- name: domElement
uid: '@microsoft/sp-adaptive-card-extension-base!BaseHTMLQuickView#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
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)'
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
isDeprecated: false
syntax:
content: |-
/** @virtual */
dispose(): void;
return:
type: void
description: ''
- name: render()
uid: '@microsoft/sp-adaptive-card-extension-base!BaseHTMLQuickView#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
isDeprecated: false
syntax:
content: |-
/** @virtual */
abstract render(): void;
return:
type: void
description: ''
- name: setState(newState)
uid: '@microsoft/sp-adaptive-card-extension-base!BaseHTMLQuickView#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
isDeprecated: false
syntax:
content: 'setState(newState?: Partial<TState> | undefined): void;'
parameters:
- id: newState
description: The new state to set.
type: Partial&lt;TState&gt; | undefined
return:
type: void
description: ''
extends: '<xref uid="@microsoft/sp-adaptive-card-extension-base!BaseQuickView:class" />&lt;TProperties, TState&gt;'
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ remarks: component configuration is the subset of component parameters that are
isPreview: false
isDeprecated: false
syntax: >-
export declare type CardComponentConfiguration<T extends ICardComponentParameters = ICardComponentParameters, K
extends keyof T | '' = ''> = Omit<T, K>;
export type CardComponentConfiguration<T extends ICardComponentParameters = ICardComponentParameters, K extends keyof
T | '' = ''> = Omit<T, K>;
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ remarks: >-
of all events supported by all components.
isPreview: false
isDeprecated: false
syntax: export declare type CardComponentEventNames = 'onChange';
syntax: export type CardComponentEventNames = 'onChange';
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ remarks: ''
isPreview: false
isDeprecated: false
syntax: >-
export declare type CardComponentName = 'text' | 'cardButton' | 'cardBar' | 'textInput' | 'searchBox' | 'searchFooter'
| 'dataVisualization';
export type CardComponentName = 'text' | 'cardButton' | 'cardBar' | 'textInput' | 'searchBox' | 'searchFooter' |
'dataVisualization' | 'poweredBy' | 'promptsSet';
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ summary: Supported data visualizations to render on the card view.
remarks: ''
isPreview: false
isDeprecated: false
syntax: export declare type CardDataVisualizationKind = 'line';
syntax: export type CardDataVisualizationKind = 'bar' | 'line' | 'pie';
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ summary: Event names supported by the search box component.
remarks: ''
isPreview: false
isDeprecated: false
syntax: export declare type CardSearchBoxEventNames = 'onChange';
syntax: export type CardSearchBoxEventNames = 'onChange';
2 changes: 1 addition & 1 deletion SP-Framework/sp-adaptive-card-extension-base/cardsize.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ summary: Size of the Card view.
remarks: ''
isPreview: false
isDeprecated: false
syntax: export declare type CardSize = 'Medium' | 'Large';
syntax: export type CardSize = 'Medium' | 'Large';
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ summary: Event names supported by the text input component.
remarks: ''
isPreview: false
isDeprecated: false
syntax: export declare type CardTextInputEventNames = 'onChange';
syntax: export type CardTextInputEventNames = 'onChange';
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ remarks: ''
isPreview: false
isDeprecated: false
syntax: >-
export declare type CardViewActionsFooterConfiguration = ICardButtonConfiguration | [ICardButtonConfiguration,
export type CardViewActionsFooterConfiguration = ICardButtonConfiguration | [ICardButtonConfiguration,
ICardButtonConfiguration] | undefined;
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ remarks: ''
isPreview: false
isDeprecated: false
syntax: >-
export declare type CardViewActionsFooterParameters = [ICardButtonParameters] | [ICardButtonParameters,
ICardButtonParameters] | undefined;
export type CardViewActionsFooterParameters = [ICardButtonParameters] | [ICardButtonParameters, ICardButtonParameters]
| undefined;
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ remarks: ''
isPreview: false
isDeprecated: false
syntax: >-
export declare type ComponentsCardViewParameters = ITextCardViewParameters | ITextInputCardViewParameters |
export type ComponentsCardViewParameters = ITextCardViewParameters | ITextInputCardViewParameters |
ISearchCardViewParameters | IDataVisualizationCardViewParameters;
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ summary: >-
remarks: ''
isPreview: false
isDeprecated: false
syntax: export declare type DeviceContext = 'WebView' | 'Mobile' | 'TeamsDesktop';
syntax: export type DeviceContext = 'WebView' | 'Mobile' | 'TeamsDesktop';
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,4 @@ summary: The footer configuration for the Generic card view templates.
remarks: 'The Generic card view templates are Basic Card View, Primary Text Card View, and Image Card View.'
isPreview: false
isDeprecated: false
syntax: >-
export declare type GenericCardViewFooterConfiguration = CardViewActionsFooterConfiguration |
ICardTextInputConfiguration;
syntax: export type GenericCardViewFooterConfiguration = CardViewActionsFooterConfiguration | ICardTextInputConfiguration;
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ summary: The footer parameters for the Generic card view templates. Can contain
remarks: 'The Generic card view templates are Basic Card View, Primary Text Card View, and Image Card View.'
isPreview: false
isDeprecated: false
syntax: 'export declare type GenericCardViewFooterParameters = CardViewActionsFooterParameters | [ICardTextInputParameters];'
syntax: 'export type GenericCardViewFooterParameters = CardViewActionsFooterParameters | [ICardTextInputParameters];'
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ remarks: >-
isPreview: false
isDeprecated: false
syntax: >-
export declare type IActionArguments = ISubmitActionArguments | IShowCardActionArguments | ISelectMediaActionArguments
| IGetLocationActionArguments | IExecuteActionArguments;
export type IActionArguments = ISubmitActionArguments | IShowCardActionArguments | ISelectMediaActionArguments |
IGetLocationActionArguments | IExecuteActionArguments;
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ remarks: >-
isPreview: false
isDeprecated: false
syntax: >-
export declare type IActionErrorArguments = IBaseActionErrorArguments | ISelectMediaActionErrorArguments |
export type IActionErrorArguments = IBaseActionErrorArguments | ISelectMediaActionErrorArguments |
ILocationErrorArguments;
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ summary: Card view icon.
remarks: The icon can be displayed as part of the card bar as well as in buttons.
isPreview: false
isDeprecated: false
syntax: export declare type IAdaptiveCardExtensionIcon = IAdaptiveCardExtensionImage;
syntax: export type IAdaptiveCardExtensionIcon = IAdaptiveCardExtensionImage;
10 changes: 7 additions & 3 deletions SP-Framework/sp-adaptive-card-extension-base/iaxis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,13 @@ properties:
fullName: labelValues
summary: An array of reference points to be represented as ticks on the axis.
remarks: >-
The number of data points is limited to ensure optimal display quality. The limit depends on the size of the card:
- Large Card: 2 to 6 data points for the x-axis - Medium Card: 2 to 3 data points for the x-axis - 2 to 4 data
points for the y-axis
The number of data points is limited to ensure optimal display quality. The limit depends on the size of the card
and dataVisualizationKind:


For a Line Chart: - Large: 2 to 6 data points for the x-axis - Medium: 2 to 3 data points for the x-axis - 2 to 4
data points for the y-axis For a Bar Chart: - Large: upto 5 data points for the x-axis - Medium: upto 3 data
points for the x-axis
isPreview: false
isDeprecated: false
syntax:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
### YamlMime:TSType
name: IBarChartCardViewConfiguration
uid: '@microsoft/sp-adaptive-card-extension-base!IBarChartCardViewConfiguration:interface'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: IBarChartCardViewConfiguration
summary: Configuration for a bar chart card view.
remarks: ''
isPreview: true
isDeprecated: false
type: interface
properties:
- name: body
uid: '@microsoft/sp-adaptive-card-extension-base!IBarChartCardViewConfiguration#body:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: body
summary: Body area components.
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: >-
body: ICardBarChartConfiguration<T> | [ICardBarChartConfiguration<T>] | [ICardTextConfiguration,
ICardBarChartConfiguration<T>];
return:
type: >-
<xref uid="@microsoft/sp-adaptive-card-extension-base!ICardBarChartConfiguration:interface" />&lt;T&gt; |
[<xref uid="@microsoft/sp-adaptive-card-extension-base!ICardBarChartConfiguration:interface" />&lt;T&gt;] |
[<xref uid="@microsoft/sp-adaptive-card-extension-base!ICardTextConfiguration:interface" />, <xref
uid="@microsoft/sp-adaptive-card-extension-base!ICardBarChartConfiguration:interface" />&lt;T&gt;]
extends: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewConfiguration:interface" />'
Loading