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

Feature: Support for speaker notes #4

Closed
mirisuzanne opened this issue Dec 23, 2023 · 3 comments · Fixed by #11
Closed

Feature: Support for speaker notes #4

mirisuzanne opened this issue Dec 23, 2023 · 3 comments · Fixed by #11
Labels
feature New feature or request

Comments

@mirisuzanne
Copy link
Member

We added this in https://github.com/oddbird/sliiides. In terms of markup, maybe notes can be added within the slide elements, so that the direct-child markup is maintained for numbering slides?

<slide-deck>
  <div><!-- this still becomes a numbered slide -->
    <div slide-content>The visual border is moved here for grid mode</div>
    <div slide-notes>Notes are hidden in list view</div>
  </div>
</slide-deck>

We might be able to automate some amount of that…

@mirisuzanne mirisuzanne added the feature New feature or request label Dec 23, 2023
@mirisuzanne mirisuzanne added this to the v1.0 Production-Ready milestone Dec 23, 2023
@mirisuzanne mirisuzanne self-assigned this Dec 23, 2023
@mirisuzanne
Copy link
Member Author

notes should be allowed in both list and grid views, I think. Is it also useful to have a notes-only option, or do notes always accompany slides?

@mirisuzanne
Copy link
Member Author

Over on oddbird/sliiides, the structure of a slide looks like this:

slide
  - slide canvas
  - slide notes

That two-part structure has worked pretty well, and seems pretty consistent across other presenting apps.

Currently, this component treats all slide-deck children as a slide canvas. But showing/hiding notes is an important part of presenting and selecting views, so I think we need to provide a bit more structure here. (While a slide canvas itself might contain more structure, that seems like a theme concern, and doesn't require any additional behavior from the presentation tool.)

I see two reasonable approaches (which could be done in parallel):

  1. A slide-group (name TBD) component with some shadow-dom and slots for canvas and notes. This provides some built-in structure, but less flexibility.
  2. A set of attributes (eg slide-canvas, and slide-notes) that authors can apply to their own markup, to get the expected behaviors. I don't think a slide-group attribute would be necessary in this case, since we can still treat every child of slide-deck as a group.

I don't think option 1 adds much over option 2, so I will likely start with the latter. If we want a slide component in the future, it should be simple enough to add on top of the attribute solution.

@mirisuzanne
Copy link
Member Author

Discussion this morning:

  • wrapper: TBD… slide-container? slide-group? slide-item?
  • internals: slide-note and slide-canvas
  • remove shadow dom styles, and provide a light dom css file

@stacyk stacyk removed their assignment Jan 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants