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

Consolidation of Text, ImageText, and Image Components #79

Open
fleven-kds opened this issue Nov 26, 2024 · 1 comment
Open

Consolidation of Text, ImageText, and Image Components #79

fleven-kds opened this issue Nov 26, 2024 · 1 comment
Labels
documentation Changes only affect the documentation enhancement New feature or request

Comments

@fleven-kds
Copy link
Collaborator

fleven-kds commented Nov 26, 2024

Previously, we had separate components for:
Text only (Text)
Image + Text (ImageText)
Image only(Image)
Each component had properties specific to its individual use case.

Current State:

Image has been removed.
ImageText is now used for "image only" use cases by not utilizing the text part of the component.
This makes Text redundant as ImageText can also be used for "text only" use cases. The implication before the removal was a strict separation of all use cases by component. This has changed now.

Suggestion:

Merge the ImageText and Text into a single unified component.
The unified component should support the following combinations:

  • Text only
  • Image only
  • Image and Text

This should be achieved through the required attribute in the JSON schema and example stories, rather than an explicit property.
Action Items:

Update the JSON schema to reflect the unified component.
Create example stories demonstrating the different use cases (Text only, Image only, Image and Text).
Update documentation to reflect the changes and guide users on how to use the unified component.

@fleven-kds fleven-kds added documentation Changes only affect the documentation enhancement New feature or request labels Nov 26, 2024
@fleven-kds fleven-kds assigned fleven-kds and unassigned fleven-kds Nov 26, 2024
@julrich julrich transferred this issue from kickstartDS/ds-agency-premium Dec 5, 2024
@julrich julrich changed the title TBD: Consolidation of Text, ImageText, and Image Components Consolidation of Text, ImageText, and Image Components Dec 5, 2024
@julrich julrich moved this to Backlog in CMS Starter Storyblok Dec 5, 2024
@julrich
Copy link
Member

julrich commented Dec 9, 2024

We keep ImageText and Text. Adjust required fields for ImageText for update use. ImageText should work for image only scenarios, where-as Text should serve text-specific stuff (multi-column, etc).

Add aspect ratio to ImageText component.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation enhancement New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

2 participants