Skip to content

Add documentation for input property order #808

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.

Sign up for GitHub

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

Open
alebon wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation for input property order #808

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/guide/08-Pitfalls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Pitfalls

This part of the guide is a collection of common problems which can arise when working with Halogen. It should help build understanding the eco-system in and around Halogen.

# Working with Inputs

When passing properties to an input field you should be aware of specific constellations. This is especially the case when using the value property.
One good pattern is to use the value property as the last (or very last) property. Have a look at the following example:

```
HH.input
[ HP.value $ show state.currentValue
, HP.type_ HP.InputRange
, HP.min 0.0
, HP.max 1.0
, HP.step $ HP.Step 0.01
, HP.required true
, HE.onValueInput $ \val -> UpdateCurrentValue val
]
```

This example won't set the initial value for currentValue properly. Unfortunately the order of properties has an effect. The correct way of this input looks as follows:

```
HH.input
[ HP.type_ HP.InputRange
, HP.min 0.0
, HP.max 1.0
, HP.step $ HP.Step 0.01
, HP.required true
, HP.value $ show state.currentValue
, HE.onValueInput $ \val -> UpdateCurrentValue val
]
```