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

[framework/documentation] custom-elements.json does not contain attributes #8392

Closed
1 task done
veith opened this issue Mar 5, 2024 · 2 comments · Fixed by #8405
Closed
1 task done

[framework/documentation] custom-elements.json does not contain attributes #8392

veith opened this issue Mar 5, 2024 · 2 comments · Fixed by #8405
Assignees
Labels
bug This issue is a bug in the code

Comments

@veith
Copy link

veith commented Mar 5, 2024

Bug Description

The dist/custom-elements.json does not have a "attributes": [] section on any component.
This information is needed to know if an attribute can be set declaratively via HTML and must not be set via JS.

This causes our linters which checks against the dist/custom-elements.json to trigger an error.

Screenshot 2024-03-05 at 11 10 19

Even the examples in the playground tells us to use the attributes, but the documentation says indirectly that you should use accessibleName via Js. This is very inconvenient.

Affected Component

All documented components with attributes

Expected Behaviour

Everything which can be passed declaratively should be listed in the attributes section of the custom-elements.json, like it was before 1.22.0

Isolated Example

https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-button--button-overview

Steps to Reproduce

No response

Log Output, Stack Trace or Screenshots

No response

Priority

Medium

UI5 Web Components Version

1.22.0

Browser

Chrome

Operating System

any

Additional Context

As a workaround, it is possible to map every member which is a field of type bool, string or something that results in a string to the attributes section.

Organization

No response

Declaration

  • I’m not disclosing any internal or sensitive information.
@veith veith added the bug This issue is a bug in the code label Mar 5, 2024
@nnaydenow nnaydenow self-assigned this Mar 5, 2024
@nnaydenow
Copy link
Contributor

Hi @veith,

Thanks for reporting this! I've linked a PR and I would ask you to check if it's working as expected.

@veith
Copy link
Author

veith commented Mar 7, 2024

@nnaydenow
I have run GenerateAPI and used the custom-elements.json. The attributes are working as expected.

Thank you for the good work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a bug in the code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants