You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently there is no indication when a certain feature/prop/method has made available, This can lead to issues since users may be using an older version of the library that does not provide this option.
What does the proposed API look like?
The idea would be to use the badge component from the default theme, this way we could indicate the version that introduced the feature.
There are multiple locations where this can be used:
Title of the component / intro explanation.
Properties and events (table)
To achieve this result, the proposed solution is to tap into the document generation step from stencil. This way, we could use an annotation that takes care of handling the correct placement of this component. This would then result in having the version in all required places. JSDoc (used by stencil) also provides the ability to use the @since tag (docs), this may be an even easier way to add the badge.
Release process may need clarification, since the developer may not know when this feature will be introduced, or better said what version number it will have
The text was updated successfully, but these errors were encountered:
What problem does this feature solve?
Currently there is no indication when a certain feature/prop/method has made available, This can lead to issues since users may be using an older version of the library that does not provide this option.
What does the proposed API look like?
The idea would be to use the badge component from the default theme, this way we could indicate the version that introduced the feature.
There are multiple locations where this can be used:
To achieve this result, the proposed solution is to tap into the document generation step from stencil. This way, we could use an annotation that takes care of handling the correct placement of this component. This would then result in having the version in all required places. JSDoc (used by stencil) also provides the ability to use the
@since
tag (docs), this may be an even easier way to add the badge.Release process may need clarification, since the developer may not know when this feature will be introduced, or better said what version number it will have
The text was updated successfully, but these errors were encountered: