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

feat(types): add banners in renderingContent #1522

Merged
merged 1 commit into from
May 7, 2024
Merged
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
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