search

trimble-oss / modus-web-components

This library provides Modus components as web components - reusable, encapsulated UI elements that are framework agnostic (can be implemented in any site).
https://modus-web-components.trimble.com/
MIT License
34 stars 70 forks source link

Improve React Documentation #2788

Open gabriel-piltzer-trimble opened 1 month ago

gabriel-piltzer-trimble commented 1 month ago

Prerequisites

Proposal

The documentation for usage of Modus Web Components in React is lacking. Our current component documentation references web component usage. Create React specific docs on how to use components, their interfaces, etc.

Ideas:

Motivation and context

Improve library usability for React developers.

What is the issue regarding ?

@trimble-oss/modus-web-components

Priority

Medium

What product/project are you using Modus Components for ?

Prism

What is your team/division name ?

Viewpoint

Are you willing to contribute ?

Yes

Are you using Modus Web Components in production ?

Yes

github-actions[bot] commented 1 month ago

Hello @gabriel-piltzer-trimble! Thanks for opening an issue. The Modus core team will get back to you soon (usually within 24-hours) and provide guidance on how to proceed. Contributors are welcome to participate in the discussion and provide their input on how to best solve the issue, and even submit a PR if they want to.

Please wait until the issue is ready to be worked on before submitting a PR, or you can reach out to the core team if it is time bound. For trivial things, or bugs that don't change the expected behaviors and UI, you can go ahead and make a PR.