-
Notifications
You must be signed in to change notification settings - Fork 1.1k
add speaker notes for slides #9533
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
Merged
Merged
Changes from 6 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
1bebfad
add speaker notes feat
Light2Dark d5ec3b8
resize speaker window, remove filename in kiosk mode
Light2Dark c5bbc33
address comments
Light2Dark 18bd7f8
only hide filename if chrome is hidden
Light2Dark 7c5702d
Update frontend/src/components/slides/slide-notes-editor.tsx
Light2Dark 46c37db
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] d6cf80e
improve types
Light2Dark 72cfcb4
make the default panel size bigger
Light2Dark 94f7fdf
add type guard
Light2Dark cd30cbd
add looseObject schema
Light2Dark a884ca3
better defaults, fix playwright selector
Light2Dark File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,12 +21,16 @@ export const SlidesLayoutPlugin: ICellRendererPlugin< | |
| type: "slides", | ||
| name: "Slides", | ||
|
|
||
| // All fields are optional so layouts saved by older marimo versions will work | ||
| // All fields are optional so layouts saved by older marimo versions will work. | ||
| // NOTE: every property of `SlideConfig` must be listed here β `z.object` | ||
| // strips unknown keys by default, so omitting a field silently drops it on | ||
| // any code path that runs the input through `validator.parse`. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe for future PR (and other plugins/validations), but would be nice for our zod schemas to be very flexible but .transform() into more strict types for the internals (wide/backward-compatible external, to narrow/strict internal type). |
||
| validator: z.object({ | ||
| cells: z | ||
| .array( | ||
| z.object({ | ||
| type: z.enum(["slide", "sub-slide", "fragment", "skip"]).optional(), | ||
| speakerNotes: z.string().optional(), | ||
| }), | ||
| ) | ||
| .optional(), | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
130 changes: 130 additions & 0 deletions
130
frontend/src/components/slides/__tests__/slide-notes.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| /* Copyright 2026 Marimo. All rights reserved. */ | ||
|
|
||
| import { describe, expect, it } from "vitest"; | ||
| import type { | ||
| SlideConfig, | ||
| SlideType, | ||
| } from "@/components/editor/renderers/slides-layout/types"; | ||
| import type { CellId } from "@/core/cells/ids"; | ||
| import { composeSlides } from "../compose-slides"; | ||
| import { buildSubslideNotes, collectBlockNotes } from "../slide-notes"; | ||
|
|
||
| interface Cell { | ||
| id: CellId; | ||
| type?: SlideType; | ||
| } | ||
|
|
||
| const cell = (id: string, type?: SlideType): Cell => ({ | ||
| id: id as CellId, | ||
|
Light2Dark marked this conversation as resolved.
Outdated
|
||
| type, | ||
| }); | ||
|
|
||
| const configs = ( | ||
| notes: Record<string, string>, | ||
| ): ReadonlyMap<CellId, SlideConfig> => | ||
| new Map( | ||
| Object.entries(notes).map(([id, speakerNotes]) => [ | ||
| id as CellId, | ||
| { speakerNotes } satisfies SlideConfig, | ||
| ]), | ||
| ); | ||
|
|
||
| const firstSubslide = (cells: Cell[]) => | ||
| composeSlides({ cells, getType: (c) => c.type ?? "slide" }).stacks[0] | ||
| .subslides[0]; | ||
|
|
||
| describe("collectBlockNotes", () => { | ||
| it("concatenates non-empty notes with paragraph spacing", () => { | ||
| const result = collectBlockNotes( | ||
| [cell("a"), cell("b"), cell("c")], | ||
| configs({ a: "first", b: "", c: "third" }), | ||
| ); | ||
| expect(result).toBe("first\n\nthird"); | ||
| }); | ||
|
|
||
| it("returns an empty string when no cell has notes", () => { | ||
| expect(collectBlockNotes([cell("a")], configs({}))).toBe(""); | ||
| }); | ||
|
|
||
| it("ignores whitespace-only notes", () => { | ||
| expect( | ||
| collectBlockNotes([cell("a"), cell("b")], configs({ a: " ", b: "x" })), | ||
| ).toBe("x"); | ||
| }); | ||
| }); | ||
|
|
||
| describe("buildSubslideNotes", () => { | ||
| it("returns empty notes when no cell has any", () => { | ||
| const subslide = firstSubslide([cell("a"), cell("b", "fragment")]); | ||
| expect(buildSubslideNotes(subslide, configs({}))).toEqual({ | ||
| slideLevel: "", | ||
| cumulativeByBlock: new Map(), | ||
| }); | ||
| }); | ||
|
|
||
| it("returns only slide-level notes when there are no fragments", () => { | ||
| const subslide = firstSubslide([cell("a")]); | ||
| expect(buildSubslideNotes(subslide, configs({ a: "intro" }))).toEqual({ | ||
| slideLevel: "intro", | ||
| cumulativeByBlock: new Map(), | ||
| }); | ||
| }); | ||
|
|
||
| it("accumulates fragments below the slide-level notes with a divider", () => { | ||
| const subslide = firstSubslide([ | ||
| cell("a"), | ||
| cell("b", "fragment"), | ||
| cell("c", "fragment"), | ||
| ]); | ||
| const { slideLevel, cumulativeByBlock } = buildSubslideNotes( | ||
| subslide, | ||
| configs({ a: "intro", b: "step one", c: "step two" }), | ||
| ); | ||
| expect(slideLevel).toBe("intro"); | ||
| expect(cumulativeByBlock.get(1)).toBe("intro\n\n---\n\nstep one"); | ||
| expect(cumulativeByBlock.get(2)).toBe( | ||
| "intro\n\n---\n\nstep one\n\n---\n\nstep two", | ||
| ); | ||
| }); | ||
|
|
||
| it("accumulates fragments with no slide-level notes", () => { | ||
| const subslide = firstSubslide([ | ||
| cell("a"), | ||
| cell("b", "fragment"), | ||
| cell("c", "fragment"), | ||
| ]); | ||
| const { slideLevel, cumulativeByBlock } = buildSubslideNotes( | ||
| subslide, | ||
| configs({ b: "first reveal", c: "second reveal" }), | ||
| ); | ||
| expect(slideLevel).toBe(""); | ||
| expect(cumulativeByBlock.get(1)).toBe("first reveal"); | ||
| expect(cumulativeByBlock.get(2)).toBe( | ||
| "first reveal\n\n---\n\nsecond reveal", | ||
| ); | ||
| }); | ||
|
|
||
| it("skips empty fragments without leaving dangling dividers", () => { | ||
| const subslide = firstSubslide([ | ||
| cell("a"), | ||
| cell("b", "fragment"), | ||
| cell("c", "fragment"), | ||
| ]); | ||
| const { cumulativeByBlock } = buildSubslideNotes( | ||
| subslide, | ||
| configs({ a: "intro", c: "third" }), | ||
| ); | ||
| expect(cumulativeByBlock.get(1)).toBe("intro"); | ||
| expect(cumulativeByBlock.get(2)).toBe("intro\n\n---\n\nthird"); | ||
| }); | ||
|
|
||
| it("returns no cumulative entries when fragments and slide have no notes", () => { | ||
| const subslide = firstSubslide([ | ||
| cell("a"), | ||
| cell("b", "fragment"), | ||
| cell("c", "fragment"), | ||
| ]); | ||
| const { cumulativeByBlock } = buildSubslideNotes(subslide, configs({})); | ||
| expect(cumulativeByBlock.size).toBe(0); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.