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

Add description to heading block widget #3442

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

taylor-steve
Copy link
Contributor

@taylor-steve taylor-steve commented Feb 14, 2025

Closes #3434
Screenshot 2025-02-14 at 1 38 54 PM

I'm not sure how I feel about this. It's probably fine as a stopgap.

The heading block template can be overridden by the host app making this inaccurate unless they also remember to update this description.

Sir Trevor supports multiple heading levels in the default config via:

      headingLevels: [2,3,4,5,6],
      defaultHeadingLevel: 2,

We'd need to start using that level data attribute in the template to select the tag.

It does use scribe for determining the levels automatically which seems to be non-functional, at least in Spotlight, and defunct: https://github.com/guardian/scribe

If we accept this and continue to use Sir Trevor for any length of time, I think we should make a new issue to create a view component for the heading block and either allow the user to select the heading level or have our own automatic scheme. Either may require design.

@taylor-steve taylor-steve force-pushed the 3434-heading-description branch from 2f4811c to 823ab48 Compare February 14, 2025 22:18
@taylor-steve taylor-steve marked this pull request as ready for review February 14, 2025 22:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature: Add explanatory text to the Heading widget
1 participant