Consider embeddable Assistant 'closeButton' behavior consistent with Gitbook's own Assistant implementation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 29k
- Forks
- 4k
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 71
Description
Description
When configuring closeButton: true via the Node.js embeddable Assistant package, the embedded assistant gets an 'X (Close)' icon in the sidebar in the bottom-left of the assistant, as described in this README.md (though missing in the public docs). With an otherwise-empty side-bar (no tabs, no actions), this populates a side-bar with only an 'X (Close)' button, uses ~60px of space
On the Gitbook docs site, the Assistant launches with an 'X (Close)' button in the top right, near the '[Trash can] (Clear conversation)' button, if you have chat content. This seems like an ideal UI, and what I assumed closeButton: true configuration would enable.
Any chance y'all would consider moving the embeddable Assistant behavior (Node.js/React/etc) to mirror the internal Gitbook assisant, with a top-right-aligned 'X (Close)' button for closeButton: true configurations?
Screenshots
- My embedded Node.js instance
- Gitbook's instance
How to reproduce
- Basic Node.js setup, using
gitbook = createGitbook(...)=>frame = gitbook.createFrame(...)=>frame.configure({ ..., closeButton: true }) - Open assistant, with 'X (Close)' in bottom left, on a left-aligned side-bar
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the embeddable Assistant configuration entry point described in packages/embed/README.md, especially the closeButton option, and compare it with the behavior shown on the GitBook docs site. Reproduce the Node.js setup with frame.configure({ closeButton: true }) and determine whether the completed behavior places Close in the top-right alongside Clear conversation without creating a sidebar-only control.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js, typescript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100