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 71 forks source link

Utility Panel Documentation #2671

Open kuhnboy opened 3 months ago

kuhnboy commented 3 months ago

Prerequisites

Describe the issue

In the example documentation:

<modus-utility-panel
      target-content="#panelcontent"
      expanded="${expanded}"
      push-content="${pushContent}"
      target-content="${targetContent}">
      <span slot="header">Utility Panel Header</span>
      <div slot="body">Content of the utility panel goes here.</div>
      <span slot="footer">Utility Panel Footer</span>
    </modus-utility-panel>

There is ambiguity related to target-content as it is defined twice. Why would one do this? Also what are the variables that are used inside of expanded, push-content and target-content?

Reduced test cases

No response

What operating system(s) are you seeing the problem on?

No response

What browser(s) are you seeing the problem on?

No response

What is the issue regarding ?

Modus Web Components Website (Storybook)

What version of npm package are you using ?

0.33.0

Priority

Low

What product/project are you using Modus Components for ?

Trimble Unity

What is your team/division name ?

O&PS

Are you willing to contribute ?

None

Are you using Modus Web Components in production ?

No response

github-actions[bot] commented 3 months ago

Hello @kuhnboy! 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.