-
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
Draft
Light2Dark
wants to merge
3
commits into
main
Choose a base branch
from
sham/speaker-notes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
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, | ||
| 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.