3pp-mirror/penpot
1
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2025-07-16 01:25:14 +02:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #6238 from penpot/luis-improve-input-with-values-doc

Browse source 
📚 Update documentation for input-with-values component
This commit is contained in:
Pablo Alba 2025-04-07 23:31:40 +02:00 • committed by GitHub
commit 230d259551
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 9 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

20
frontend/src/app/main/ui/ds/controls/input_with_values.mdx
View file

@ -5,15 +5,15 @@ import * as InputWithValuesStories from "./input_with_values.stories";
# InputWithValues # InputWithValues
The `input-with-values*` acts as an input with an addition of a series of values that are only indicators. The `input-with-values*` acts as an input with an optional addition of a series of values that are only indicators, and an event which is triggered when the focus is lost.
<Canvas of={InputWithValuesStories.Default} /> <Canvas of={InputWithValuesStories.Default} />
## Technical notes ## Technical notes
* You need to pass the mandatory string properties `name` and `values` * You need to pass the mandatory string property `name`.
* You can pass a function property `on-blur` that will be called with the blur event when the component lost focus (including when the user press enter or esc) * You can pass the optional string property `values`.
* You can pass a function property `on-blur` that will be called with the blur event when the component loses focus (including when the user presses enter or esc).
```clj ```clj
[:> input-with-values* [:> input-with-values*
@ -22,16 +22,14 @@ The `input-with-values*` acts as an input with an addition of a series of values
:on-blur on-blur}] :on-blur on-blur}]
``` ```
## Usage guidelines (design) ## Usage guidelines (design)
### When to use ### When to use
When we have an element that need to be editable, and an extra set of values that aren't editables and are only indicators When we have an element that can be editable, but doesn't change its appearance on hover, and adds an extra set of values that aren't editable (they're just indicators).
### Interaction / Behavior ### Interaction / Behavior
* The component starts on "display" mode, showing the name and the values
* Once the user clicks on it, the input goes into "active" mode and the only thing that remains and that is editable is the name (the values are hidden) * The component starts on "display" mode, showing the name and the values.
* If the user press enter or esc, the component goes back to "display" mode * Once the user clicks on it, the input goes into "active" mode and the only thing that remains and can be editable is the name (the values are hidden).
* If the user presses enter or esc, the component goes back to "display" mode.