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

Issue-1074: Add Support for an Aside Component (release/v2.5.0) #1101

Merged

Conversation

mogmarsh
Copy link

Description

It's a common pattern for publishers to include a sidebar or aside element to appear alongside their content, which doesn't translate well (if at all) into Apple News format. Since this is custom functionality, we will need a way to map custom sidebars or aside elements to this new component:

  1. Create a new Aside component
  2. Add a configuration option to let publishers enter a CSS class that denotes content that should be incorporated into the new Aside component
  3. If a container is encountered that has the specified class, it should be incorporated into the new Aside component rather than whatever it would have been otherwise
  4. Add new theme settings to determine what the appearance of the Aside component should be, with sensible defaults for the default theme and the sample themes that ship with the plugin; the component should be visually distinguishable since on mobile it will appear between paragraphs; also allow alignment to be set (left/right)
  5. Configure display for the component so that text wraps around it on larger viewports but it appears between paragraphs on small viewports

Use Case

When a publisher uses an aside or sidebar component in their article body, it should be properly reflected in Apple News.

Issue Link

Add Support for an Aside Component

@dlh01 dlh01 force-pushed the feature/issue-1074/add-support-aside-component branch from 9f66a47 to d5b59c2 Compare May 8, 2024 05:55
@kevinfodness kevinfodness marked this pull request as ready for review May 9, 2024 15:28
Copy link
Member

@kevinfodness kevinfodness left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a test, but can follow up with a separate PR for that. 🍣

@kevinfodness kevinfodness merged commit 77f535b into release/v2.5.0 May 9, 2024
11 checks passed
@kevinfodness kevinfodness deleted the feature/issue-1074/add-support-aside-component branch May 9, 2024 19:25
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.

None yet

3 participants