Merge pull request #62 from SharePoint/main

SPFx 1.18.0-rc.1 API

Author: AJIXuMuK

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

@@ -56,20 +56,20 @@ interfaces:
   - '@microsoft/sp-adaptive-card-extension-base!ICardBarConfiguration:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardBarParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardButton:interface'
-  - '@microsoft/sp-adaptive-card-extension-base!ICardButtonBaseParameters:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!ICardButtonBase:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardButtonConfiguration:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardButtonParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardComponentParameters: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'
-  - '@microsoft/sp-adaptive-card-extension-base!ICardSearchBoxTitleButtonParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardSearchFooterConfiguration:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardSearchFooterParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardTextConfiguration:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardTextInputConfiguration:interface'
-  - '@microsoft/sp-adaptive-card-extension-base!ICardTextInputIconButtonParameters:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!ICardTextInputIconButton:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardTextInputParameters:interface'
-  - '@microsoft/sp-adaptive-card-extension-base!ICardTextInputTitleButtonParameters:interface'
+  - '@microsoft/sp-adaptive-card-extension-base!ICardTextInputTitleButton:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardTextParameters:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardViewConfiguration:interface'
   - '@microsoft/sp-adaptive-card-extension-base!ICardViewParameters:interface'
@@ -127,7 +127,7 @@ functions:
     package: '@microsoft/sp-adaptive-card-extension-base!'
     summary: Helper method to create a Basic Card View.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'export declare function BasicCardView(configuration: IBasicTextCardViewConfiguration): ITextCardViewParameters;'
@@ -143,7 +143,7 @@ functions:
     package: '@microsoft/sp-adaptive-card-extension-base!'
     summary: Helper method to create an Image Card View.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'export declare function ImageCardView(configuration: IImageCardViewConfiguration): ITextCardViewParameters;'
@@ -159,7 +159,7 @@ functions:
     package: '@microsoft/sp-adaptive-card-extension-base!'
     summary: Helper method to create a Primary Text Card View.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: >-
@@ -177,7 +177,7 @@ functions:
     package: '@microsoft/sp-adaptive-card-extension-base!'
     summary: Helper method to create a Search Card View.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'export declare function SearchCardView(configuration: ISearchCardViewConfiguration): ISearchCardViewParameters;'
@@ -193,7 +193,7 @@ functions:
     package: '@microsoft/sp-adaptive-card-extension-base!'
     summary: Helper method to create an Text Input Card View.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: >-
@@ -211,7 +211,7 @@ functions:
     package: '@microsoft/sp-adaptive-card-extension-base!'
     summary: Helper method to create an Text Input with Image Card View.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: >-

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

@@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: BaseComponentsCardView
 summary: Base class for an component-based Card views.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 type: class
 properties:
@@ -15,7 +15,7 @@ properties:
     fullName: cardViewParameters
     summary: The Card view configuration.
     remarks: 'The property must return the full configuration of the card view, including title and actions.'
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'abstract get cardViewParameters(): TParameters;'

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

@@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: CardComponentConfiguration
 summary: Base component configuration.
 remarks: component configuration is the subset of component parameters that are available to a developer for customizations.
-isPreview: true
+isPreview: false
 isDeprecated: false
 syntax: >-
   export declare type CardComponentConfiguration<T extends ICardComponentParameters = ICardComponentParameters, K

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

@@ -7,6 +7,6 @@ summary: List of all events supported by components.
 remarks: >-
   For the events supported by a specific component, see type definition for that component. This type describes a union
   of all events supported by all components.
-isPreview: true
+isPreview: false
 isDeprecated: false
 syntax: export declare type CardComponentEventNames = 'onChange';

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

@@ -3,9 +3,9 @@ name: CardComponentName
 uid: '@microsoft/sp-adaptive-card-extension-base!CardComponentName:type'
 package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: CardComponentName
-summary: Allowed component names
+summary: Names of the components allowed in a card view.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 syntax: >-
   export declare type CardComponentName = 'text' | 'cardButton' | 'cardBar' | 'textInput' | 'searchBox' |

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

@@ -3,8 +3,8 @@ name: CardSearchBoxEventNames
 uid: '@microsoft/sp-adaptive-card-extension-base!CardSearchBoxEventNames:type'
 package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: CardSearchBoxEventNames
-summary: Event names for the search box component.
+summary: Event names supported by the search box component.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 syntax: export declare type CardSearchBoxEventNames = 'onChange';

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

@@ -3,8 +3,8 @@ name: CardTextInputEventNames
 uid: '@microsoft/sp-adaptive-card-extension-base!CardTextInputEventNames:type'
 package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: CardTextInputEventNames
-summary: Event names for the text input component.
+summary: Event names supported by the text input component.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 syntax: export declare type CardTextInputEventNames = 'onChange';

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

@@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: CardViewActionsFooterConfiguration
 summary: The actions-only footer configuration for the card view.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 syntax: >-
   export declare type CardViewActionsFooterConfiguration = ICardButtonConfiguration | [ICardButtonConfiguration,

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

@@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: CardViewActionsFooterParameters
 summary: The actions-only footer parameters for the card view.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 syntax: >-
   export declare type CardViewActionsFooterParameters = [ICardButtonParameters] | [ICardButtonParameters,

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

@@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: ComponentsCardViewParameters
 summary: Card view configuration type.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 syntax: >-
   export declare type ComponentsCardViewParameters = ITextCardViewParameters | ITextInputCardViewParameters |

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

@@ -5,7 +5,7 @@ package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: GenericCardViewFooterConfiguration
 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: true
+isPreview: false
 isDeprecated: false
 syntax: >-
   export declare type GenericCardViewFooterConfiguration = CardViewActionsFooterConfiguration |

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

@@ -3,8 +3,8 @@ name: GenericCardViewFooterParameters
 uid: '@microsoft/sp-adaptive-card-extension-base!GenericCardViewFooterParameters:type'
 package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: GenericCardViewFooterParameters
-summary: The footer parameters for the Generic card view templates.
+summary: The footer parameters for the Generic card view templates. Can contain either 0 to 2 buttons or a single text input.
 remarks: 'The Generic card view templates are Basic Card View, Primary Text Card View, and Image Card View.'
-isPreview: true
+isPreview: false
 isDeprecated: false
 syntax: 'export declare type GenericCardViewFooterParameters = CardViewActionsFooterParameters | [ICardTextInputParameters];'

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

@@ -3,8 +3,8 @@ name: IAdaptiveCardExtensionIcon
 uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionIcon:type'
 package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: IAdaptiveCardExtensionIcon
-summary: Card view icon parameters.
-remarks: ''
-isPreview: true
+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;

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

@@ -3,9 +3,9 @@ name: IAdaptiveCardExtensionImage
 uid: '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionImage:interface'
 package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: IAdaptiveCardExtensionImage
-summary: Card view image parameters.
-remarks: ''
-isPreview: true
+summary: Properties for the image rendered in a card view.
+remarks: The image can be displayed as part of the card view itself as well as in buttons.
+isPreview: false
 isDeprecated: false
 type: interface
 properties:
@@ -15,7 +15,7 @@ properties:
     fullName: altText
     summary: The alt text.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'altText?: string;'
@@ -27,7 +27,7 @@ properties:
     fullName: url
     summary: The URL to display as image or icon.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'url: string;'

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

@@ -7,7 +7,7 @@ summary: Configuration for a Basic Card view.
 remarks: >-
   The basic Card view displays the following: - Card title - Card icon - One primary text field - One button in the
   `Medium` Card size, two buttons in the `Large` Card size, or text input in the footer
-isPreview: true
+isPreview: false
 isDeprecated: false
 type: interface
 properties:
@@ -17,7 +17,7 @@ properties:
     fullName: footer
     summary: Footer area components.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'footer: GenericCardViewFooterConfiguration;'
@@ -29,7 +29,7 @@ properties:
     fullName: header
     summary: Header area components.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'header: ICardTextConfiguration;'

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

@@ -3,9 +3,9 @@ name: ICardBarConfiguration
 uid: '@microsoft/sp-adaptive-card-extension-base!ICardBarConfiguration:interface'
 package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: ICardBarConfiguration
-summary: Secondary text component configuration.
-remarks: ''
-isPreview: true
+summary: Card view title area (card bar) component configuration.
+remarks: component configuration is the subset of component parameters that are available to a developer for customizations.
+isPreview: false
 isDeprecated: false
 type: interface
 extends: >-

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

@@ -3,9 +3,9 @@ name: ICardBarParameters
 uid: '@microsoft/sp-adaptive-card-extension-base!ICardBarParameters:interface'
 package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: ICardBarParameters
-summary: Card view title area (card bar) parameters
+summary: Card view title area (card bar) component parameters
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 type: interface
 properties:
@@ -15,7 +15,7 @@ properties:
     fullName: componentName
     summary: Unique component name.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'componentName: ''cardBar'';'
@@ -27,7 +27,7 @@ properties:
     fullName: icon
     summary: The icon to display.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'icon?: IAdaptiveCardExtensionIcon;'
@@ -39,7 +39,7 @@ properties:
     fullName: title
     summary: The title to display.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'title?: string;'

SP-Framework/sp-adaptive-card-extension-base/icardbuttonbaseparameters.yml renamed to SP-Framework/sp-adaptive-card-extension-base/icardbuttonbase.yml

@@ -1,33 +1,35 @@
 ### YamlMime:TSType
-name: ICardButtonBaseParameters
-uid: '@microsoft/sp-adaptive-card-extension-base!ICardButtonBaseParameters:interface'
+name: ICardButtonBase
+uid: '@microsoft/sp-adaptive-card-extension-base!ICardButtonBase:interface'
 package: '@microsoft/sp-adaptive-card-extension-base!'
-fullName: ICardButtonBaseParameters
-summary: Base parameters for the buttons used in different ACE card view components.
+fullName: ICardButtonBase
+summary: >-
+  Base properties for the buttons used in different ACE card view components, such as Text Input and Search Box and Card
+  Button.
 remarks: ''
-isPreview: true
+isPreview: false
 isDeprecated: false
 type: interface
 properties:
   - name: action
-    uid: '@microsoft/sp-adaptive-card-extension-base!ICardButtonBaseParameters#action:member'
+    uid: '@microsoft/sp-adaptive-card-extension-base!ICardButtonBase#action:member'
     package: '@microsoft/sp-adaptive-card-extension-base!'
     fullName: action
     summary: The type of the button.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'action: ICardAction;'
       return:
         type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!ICardAction:type" />'
   - name: id
-    uid: '@microsoft/sp-adaptive-card-extension-base!ICardButtonBaseParameters#id:member'
+    uid: '@microsoft/sp-adaptive-card-extension-base!ICardButtonBase#id:member'
     package: '@microsoft/sp-adaptive-card-extension-base!'
     fullName: id
     summary: Unique Id of the button.
     remarks: ''
-    isPreview: true
+    isPreview: false
     isDeprecated: false
     syntax:
       content: 'id?: string;'

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

@@ -4,8 +4,8 @@ uid: '@microsoft/sp-adaptive-card-extension-base!ICardButtonConfiguration:interf
 package: '@microsoft/sp-adaptive-card-extension-base!'
 fullName: ICardButtonConfiguration
 summary: Card button component configuration.
-remarks: ''
-isPreview: true
+remarks: component configuration is the subset of component parameters that are available to a developer for customizations.
+isPreview: false
 isDeprecated: false
 type: interface
 extends: >-