Skip to content
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

fix(answerConfigurationId): remove internal tag #4922

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -984,14 +984,14 @@ export declare interface AtomicFormatUnit extends Components.AtomicFormatUnit {}


@ProxyCmp({
inputs: ['collapsible', 'maxCollapsedHeight', 'tabsExcluded', 'tabsIncluded', 'withToggle']
inputs: ['answerConfigurationId', 'collapsible', 'maxCollapsedHeight', 'tabsExcluded', 'tabsIncluded', 'withToggle']
})
@Component({
selector: 'atomic-generated-answer',
changeDetection: ChangeDetectionStrategy.OnPush,
template: '<ng-content></ng-content>',
// eslint-disable-next-line @angular-eslint/no-inputs-metadata-property
inputs: ['collapsible', 'maxCollapsedHeight', 'tabsExcluded', 'tabsIncluded', 'withToggle'],
inputs: ['answerConfigurationId', 'collapsible', 'maxCollapsedHeight', 'tabsExcluded', 'tabsIncluded', 'withToggle'],
})
export class AtomicGeneratedAnswer {
protected el: HTMLElement;
Expand Down
6 changes: 6 additions & 0 deletions packages/atomic/src/components.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1085,6 +1085,9 @@ export namespace Components {
* For more information, see [About Relevance Generative Answering (RGA)](https://docs.coveo.com/en/n9de0370/)
*/
interface AtomicGeneratedAnswer {
/**
* The unique identifier of the answer configuration to use to generate the answer.
*/
"answerConfigurationId"?: string;
/**
* Whether to allow the answer to be collapsed when the text is taller than the specified `--atomic-crga-collapsed-height` value (16rem by default).
Expand Down Expand Up @@ -7277,6 +7280,9 @@ declare namespace LocalJSX {
* For more information, see [About Relevance Generative Answering (RGA)](https://docs.coveo.com/en/n9de0370/)
*/
interface AtomicGeneratedAnswer {
/**
* The unique identifier of the answer configuration to use to generate the answer.
*/
"answerConfigurationId"?: string;
/**
* Whether to allow the answer to be collapsed when the text is taller than the specified `--atomic-crga-collapsed-height` value (16rem by default).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,6 @@ export class AtomicGeneratedAnswer implements InitializableComponent {
@Prop() maxCollapsedHeight = this.DEFAULT_COLLAPSED_HEIGHT;

/**
* @internal
* The unique identifier of the answer configuration to use to generate the answer.
*/
@Prop() answerConfigurationId?: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ export default class QuanticGeneratedAnswer extends LightningElement {
*/
@api withToggle = false;
/**
* @internal
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Quantic we use the tag @api in the JS doc for public properties,
it should be something like this:

  /**
   * @api
   * The unique identifier of the answer configuration to use to generate the answer.
   * @type {string}
   */
  @api answerConfigurationId;

* The unique identifier of the answer configuration to use to generate the answer.
* @type {string}
*/
Expand Down
Loading