diff --git a/.changeset/slimy-coins-talk.md b/.changeset/slimy-coins-talk.md new file mode 100644 index 000000000..b1baa6a36 --- /dev/null +++ b/.changeset/slimy-coins-talk.md @@ -0,0 +1,6 @@ +--- +"@gitbook/embed": minor +"gitbook": patch +--- + +Docs Embed: Make trademark optional diff --git a/packages/embed/README.md b/packages/embed/README.md index f8faaf46d..4c24868b9 100644 --- a/packages/embed/README.md +++ b/packages/embed/README.md @@ -269,6 +269,19 @@ Notes: - The close button is rendered in the same sidebar area as tabs/actions. - If your UI hides that sidebar or doesn't render it, the button will not be visible. +### `trademark` + +Available in: Standalone script, NPM package, React components + +Display GitBook branding in the embed. Defaults to true. + +- **Type**: `boolean` +- **Default**: `true` + +```javascript +trademark: true +``` + ### `actions` Available in: Standalone script, NPM package, React components diff --git a/packages/embed/src/client/createGitBookFrame.ts b/packages/embed/src/client/createGitBookFrame.ts index 84908521b..f4146536a 100644 --- a/packages/embed/src/client/createGitBookFrame.ts +++ b/packages/embed/src/client/createGitBookFrame.ts @@ -69,6 +69,7 @@ export function createGitBookFrame(iframe: HTMLIFrameElement): GitBookFrameClien greeting: { title: '', subtitle: '' }, suggestions: [], tools: [], + trademark: true, }; return { diff --git a/packages/embed/src/client/protocol.ts b/packages/embed/src/client/protocol.ts index acfb13974..7413783b8 100644 --- a/packages/embed/src/client/protocol.ts +++ b/packages/embed/src/client/protocol.ts @@ -68,6 +68,11 @@ export type GitBookEmbeddableConfiguration = { /** Tools to be provided to the assistant. */ tools: GitBookToolDefinition[]; + /** + * Display GitBook branding in the embed. + */ + trademark?: boolean; + /** * Display a close button inside the assistant. */ diff --git a/packages/embed/src/react/GitBookFrame.tsx b/packages/embed/src/react/GitBookFrame.tsx index 7ef43fa9e..479943b55 100644 --- a/packages/embed/src/react/GitBookFrame.tsx +++ b/packages/embed/src/react/GitBookFrame.tsx @@ -25,6 +25,7 @@ export function GitBookFrame(props: GitBookFrameProps) { suggestions = [], tools = [], tabs = ['assistant', 'docs'], + trademark = true, closeButton = false, } = props; @@ -48,8 +49,9 @@ export function GitBookFrame(props: GitBookFrameProps) { suggestions, tools, closeButton, + trademark, }); - }, [gitbookFrame, actions, greeting, suggestions, tools, tabs, closeButton]); + }, [gitbookFrame, actions, greeting, suggestions, tools, tabs, closeButton, trademark]); return (