Skip to content

Commit

Permalink
feat(types): add banners in renderingContent (#1522)
Browse files Browse the repository at this point in the history
  • Loading branch information
aymeric-giraudet authored May 7, 2024
1 parent f49a6bc commit 5828389
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions packages/client-search/src/types/Settings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,49 @@ export type Settings = {
};
};
};
/**
* Defining UI widget configuration
*/
readonly widgets?: {
/**
* Configuration for banners
*/
readonly banners?: ReadonlyArray<{
/**
* Configuration for the banner image
*/
readonly image: {
/**
* Set of possible URLs of the banner image
*/
readonly urls: ReadonlyArray<{
/**
* URL of the banner image
*/
readonly url: string;
}>;
/**
* Alt text of the banner image
*/
readonly title?: string;
};
/**
* Configuration for the banner click navigation
*/
readonly link?: {
/**
* URL to navigate to when the banner is clicked
*/
readonly url?: string;
/**
* Target of the navigation
* - `_blank` opens the URL in a new tab
* - `_self` opens the URL in the same tab
*/
readonly target?: '_blank' | '_self';
};
}>;
};
};

/**
Expand Down

0 comments on commit 5828389

Please sign in to comment.