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.

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

Jump to bottom

Docs: Explain about options object for strings #152

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

Docs: Explain about options object for strings #152

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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,19 @@ to the different states of the checkbox input element, in the following order:
_unchecked state_ ([example](https://github.com/openstreetmap/id-tagging-schema/blob/2375a6b/data/fields/parcel_pickup.json))
2. fields of type `defaultCheck`: _unchecked state_ (must use the option `undefined`), _checked state_ ([example](https://github.com/openstreetmap/id-tagging-schema/blob/2375a6b/data/fields/crossing_raised.json))

**Custom tooltips:**

In iD and Rapid, the default tooltip on an options string is the raw tag value. You can provide a custom tooltip via an options object:
```
"options": {
"yes": {
"title": "Allowed",
"description": "Access allowed by law; a right of way"
}
}
```
In this case, iD and Rapid will not show the original tag value but only the `description`.

##### `stringsCrossReference`

An optional property to reference to the strings of another field, indicated by using that field's name contained in brackets, like `{field}`. This is for example useful when there are multiple variants of fields for the same tag, which should all use the same strings.
Expand Down
Loading