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

Add "Required" property and inline action slot calcite input labels #5079

Open
Tracked by #5529
mitc7862 opened this issue Aug 3, 2022 · 17 comments
Open
Tracked by #5529

Add "Required" property and inline action slot calcite input labels #5079

mitc7862 opened this issue Aug 3, 2022 · 17 comments
Assignees
Labels
1 - assigned Issues that are assigned to a sprint and a team member. ArcGIS Online Issues logged by ArcGIS Online team members. ArcGIS Web Analysis Issues logged by ArcGIS Web Analysis team members blocked This issue is blocked by another issue. design Issues that need design consultation prior to development. enhancement Issues tied to a new feature or request. p - high Issue should be addressed in the current milestone, impacts component or core functionality ready for dev Issues ready for development implementation. refactor Issues tied to code that needs to be significantly reworked. spike complete Issues that have a research spike completed and dev work can proceed
Milestone

Comments

@mitc7862
Copy link

mitc7862 commented Aug 3, 2022

Description

We need a better way to indicate to users when fields are required in order to run an analysis tool.
We also need the ability to let users show parameter-specific help. Both of these needs could be met by enhancing the calcite label component to have the following:

  1. A boolean property that allows developers to indicate if a form field is required. If the property is set to true, there would be a red indicator that trails the label text (See the image below for my design proposal).
  2. A generic slot at the end of the label component that allows developers to include a link or an action. In the case of analysis, we would use this to trigger a popover.

image

Acceptance Criteria

Required property:

  • When a property is set to "True" the required field is clearly indicated
  • When the user hovers over a required indicator, there is a tooltip that says "Required"
  • If a required field is focused using a screen reader, the word "required" is read following the name of the input.

Action slot:

  • A developer is able to include interactive content (i.e. a link or link icon) within the label component.

Relevant Info

This enhancement is needed for the Analysis "min ship", which is slated for the 10.3 online release.

Which Component

Calcite Label for

  • Input
  • Select
  • Combobox
  • Text area (future)
  • Any other component wrapping calcite label

Example Use Case

No response

@mitc7862 mitc7862 added enhancement Issues tied to a new feature or request. 0 - new New issues that need assignment. needs triage Planning workflow - pending design/dev review. labels Aug 3, 2022
@macandcheese
Copy link
Contributor

macandcheese commented Aug 3, 2022

@benelan @jcfranco - noted as high priority. Mitch has available cycles to help with design if needed.

From design standpoint - would need to figure out how to display this / position the slot amongst other unnamed content slotted in label - the inline / inline-space-between layouts would need to be considered.

It is achievable currently: https://codepen.io/mac_and_cheese/pen/LYddREp?editors=1000

But the label's click handler focuses the child control when clicking on the slotted actions - maybe an opt-out class consumers could use to exclude slotted elements like actions as shown above could be an interim fix / helper?

@benelan benelan added the p - high Issue should be addressed in the current milestone, impacts component or core functionality label Aug 3, 2022
@subgan82
Copy link

subgan82 commented Sep 2, 2022

Hi All

Any update on this issue , we are looking to use this for showing analysis help for parameters. Can we have it for Online release 10.3?

@ashetland ashetland added this to the 2023 January Priorities milestone Dec 2, 2022
@geospatialem geospatialem removed this from the 2023 January Priorities milestone Dec 2, 2022
@geospatialem geospatialem added the refactor Issues tied to code that needs to be significantly reworked. label Dec 2, 2022
@geospatialem
Copy link
Member

Adding the slot will require a major refactor, and will be prioritized after next month's release. cc: @ashetland, @Elijbet

Once prioritized the effort should be coupled with #2793 and #4155.

@geospatialem geospatialem removed the needs triage Planning workflow - pending design/dev review. label Mar 3, 2023
@geospatialem geospatialem added 1 - assigned Issues that are assigned to a sprint and a team member. and removed 0 - new New issues that need assignment. labels Mar 3, 2023
@ashetland ashetland added the design Issues that need design consultation prior to development. label Mar 29, 2023
@macandcheese
Copy link
Contributor

Design consideration here must include the inline and inline space between layout types of label.

@ashetland
Copy link
Contributor

Is there a need for a slot at both start and end positions as noted in issue #4155 (pictured below), or are we looking for just an end slot shown in the above examples?
image

@geospatialem
Copy link
Member

Follow-up includes:

@jcfranco jcfranco added the needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. label Oct 21, 2023
@jcfranco jcfranco removed their assignment Oct 21, 2023
@geospatialem geospatialem added the 0 - new New issues that need assignment. label Oct 23, 2023
@brittneytewks brittneytewks added the spike complete Issues that have a research spike completed and dev work can proceed label Nov 17, 2023
Copy link
Contributor

cc @geospatialem, @brittneytewks

@geospatialem geospatialem removed the needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. label Nov 22, 2023
@brittneytewks brittneytewks removed the figma changes Issues that require additions or updates to the Figma UI Kit where no `design` label exists label Dec 12, 2023
@geospatialem geospatialem added the blocked This issue is blocked by another issue. label Jan 8, 2024
@geospatialem
Copy link
Member

Blocked by the efforts of a built-in label across form components via #8572, targeted in the January milestone.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - assigned Issues that are assigned to a sprint and a team member. ArcGIS Online Issues logged by ArcGIS Online team members. ArcGIS Web Analysis Issues logged by ArcGIS Web Analysis team members blocked This issue is blocked by another issue. design Issues that need design consultation prior to development. enhancement Issues tied to a new feature or request. p - high Issue should be addressed in the current milestone, impacts component or core functionality ready for dev Issues ready for development implementation. refactor Issues tied to code that needs to be significantly reworked. spike complete Issues that have a research spike completed and dev work can proceed
Projects
None yet
Development

No branches or pull requests

9 participants