Documentation updates

This commit is contained in:
Pieter Vander Vennet 2021-11-08 02:36:01 +01:00
parent 78c689b7e8
commit 09eee08fbc
32 changed files with 600 additions and 87 deletions

View file

@ -1,4 +1,5 @@
Available types for text fields
=================================
@ -12,7 +13,7 @@ A basic string
## text
A string, but allows input of longer strings more comfortably (a text area)
A string, but allows input of longer strings more comfortably and supports newlines (a text area)
## date
@ -29,6 +30,7 @@ A geographical length in meters (rounded at two points). Will give an extra mini
## wikidata
A wikidata identifier, e.g. Q42.
### Helper arguments
@ -44,6 +46,7 @@ removePrefixes | remove these snippets of text from the start of the passed stri
removePostfixes | remove these snippets of text from the end of the passed string to search
### Example usage
The following is the 'freeform'-part of a layer config which will trigger a search for the wikidata item corresponding with the name of the selected feature. It will also remove '-street', '-square', ... if found at the end of the name
@ -102,6 +105,7 @@ A phone number
## opening_hours
Has extra elements to easily input when a POI is opened.
### Helper arguments
@ -116,6 +120,7 @@ prefix | Piece of text that will always be added to the front of the generated o
postfix | Piece of text that will always be added to the end of the generated opening hours
### Example usage
To add a conditional (based on time) access restriction:
@ -138,4 +143,6 @@ postfix | Piece of text that will always be added to the end of the generated op
## color
Shows a color picker Generated from ValidatedTextField.ts
Shows a color picker
This document is autogenerated from ValidatedTextField.ts