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

The "SmartLabel" class doesn't exist in the "sap.ui.comp.smartfield" namespace. #430

Closed
kozubikmichal opened this issue Oct 25, 2021 · 2 comments

Comments

@kozubikmichal
Copy link

sap.ui.comp.smartfield.SmartLabel is not explicitly exposed by the framework although the documentation itself shows its usage in combination with the SmartField control:
https://sapui5.hana.ondemand.com/#/api/sap.ui.comp.smartfield.SmartField

Therefore user would expect this syntax to be supported. Unfortunately this is not true:

image

@boghyon
Copy link

boghyon commented Jul 24, 2022

I don't think there is anything UI5 Language Assistant can do here. According to the SmartField API reference:

Although the sap.ui.comp.smartfield.SmartLabel is a private/internal control, the following basic use is allowed by applications for labeling the SmartField control.

I find this highly questionable since framework/control developers are supposed to adhere to the JSDoc Visibility Tags guidelines. And according to the Compatibility Rules:

[Application developers should] never use or override "private" functions that aren't part of the API Reference.

As such, sap.ui.comp.smartfield.SmartLabel should get the @public tag so that it appears in the API Reference if it's allowed to be used by applications.

@petermuessig
Copy link
Contributor

The UI5 Language Assistant only displays the public API. Experimental, protected, restricted and private API will not be shown. All infos used by the UI5 Language Assistant is built on top of the JSDoc of UI5. If the API is available there publically it can be used.

BTW: The latest version 3.2.1 brings multi-version support for the UI5 Language Assistant. The version is derived from the minUI5Version of the closest manifest.json and resolved against the latest available and supported versions from UI5.

Fixed with PR #472 #469

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

No branches or pull requests

3 participants