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

[JEWEL-792] Add slot-based API for InlineBanner #3012

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

rock3r
Copy link
Collaborator

@rock3r rock3r commented Mar 31, 2025

This adds a slot-based API to InlineBanner, in addition to the String-based API that already exists. It is a non-breaking change. The reason is to allow users to specify their own main content, e.g., to use Markdown. The title is unaffected as it remains plain text.

Important

This PR needs #2999 to be merged first

Additionally, this fixes the KDoc for InlineBanner by making sure there is no content after the tags section. Before this all the content after the last tag would be considered to be part of the tag itself's documentation, which is incorrect.

The KDocs have also been rewritten for correctness and to improve clarity, making them simpler and more readable.

@rock3r rock3r requested a review from hamen March 31, 2025 16:29
@rock3r rock3r self-assigned this Mar 31, 2025
@rock3r rock3r added the Jewel label Mar 31, 2025
@rock3r
Copy link
Collaborator Author

rock3r commented Mar 31, 2025

@hamen you can review the last commit only, until the base PR is merged that's the only difference

This adds a slot-based API to InlineBanner, in addition to
the String-based API that already exists. It is a
non-breaking change. The reason is to allow users to specify
their own main content, e.g., to use Markdown. The title is
unaffected as it remains plain text.

Additionally, this fixes the KDoc for InlineBanner by making
sure there is no content after the tags section. Before this
all the content after the last tag would be considered to be
part of the tag itself's documentation, which is incorrect.

The KDoc have also been rewritten for correctness and to
improve clarity, making them simpler and more readable.
@rock3r rock3r force-pushed the sebp/JEWEL-792_markdown-text-in-banners branch from 0079b9f to f094744 Compare April 1, 2025 10:55
@rock3r
Copy link
Collaborator Author

rock3r commented Apr 2, 2025

ready to merge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants