Formular
Formular til indsamling af data fra brugerne
En formular kan både vises med eller uden kort. Det er muligt at have forskellige typer input, som f.eks. tekst, email og adresse.
Formularen kan også bruges til at redigere eksisterende data. Se data.
Options
Herunder findes en beskrivelse af de enkelte egenskaber, der kan angives til denne funktion.
disable
- Type:
boolean - Default:
false
Skal kontrollen deaktiveres. Herved fungerer det, som om kontrollen ikke var tilføjet. Kan bruges til midlertidig at fjerne en kontrol.
detach
- Type:
string
Angiv en reference til et alternativ html-element, som denne kontrol skal vises i. Det kan benyttes til at placere indholdet af en kontrol et andet sted på sin side. Hvis detach har værdien "abc", så skal der tilføjes et element til HTML'en på denne form: <div data-widget-detach="abc"/>. Hvis elementet ikke findes, så fungerer kontrollen, som hvis detach ikke var angivet.
css
- Type:
string | string[]
Angiv en sti til en css-fil, der skal loades efter denne kontrol. Herved vil det være muligt at lave en brugertilpasset style af kontrollen.
Indlæs én eller flere CSS filer på denne måde:
json
"css": [
"https://septima.dk/widget/custom.css"
]header
- Type:
string
HTML, der vises øverst i formularen, f.eks. "<h2>Reservér grund</h2>". Når header er angivet, vises også en undertekst. Se subheader.
subheader
- Type:
string - Default:
"<p class="widget-form-subheader">Felter med <span>*</span> skal være udfyldt</p>"
HTML, der vises under header. Vises kun, når header er angivet.
fieldsRequiredText
- Type:
string - Default:
"Felter med <span>*</span> skal være udfyldt"
Tekst, der vises over knappen, når mindst ét felt har isRequired: true.
submitButtonText
- Type:
string - Default:
"Indsend"
Teksten på knappen. Det er en template, der får konfigurationen som data. Ved redigering er edit sat til true, så teksten kan skifte, f.eks. "<%= edit ? 'Gem' : 'Opret' %>".
fields
- Type:
array
Liste med de felter, der skal vises. Hvert element er enten et felt eller en liste af felter. En liste af felter vises samlet i én boks, mens et enkelt felt får sin egen boks.
json
"fields": [
[
{ "name": "name", "type": "input", "label": "Navn", "isRequired": true },
{ "name": "email", "type": "email", "label": "E-mail", "isRequired": true }
],
{ "name": "comment", "type": "textarea", "label": "Kommentar" }
]Se felter for en beskrivelse af de enkelte felter.
host
- Type:
string
URL'en, som formularen sendes til. Det er en template, der får konfigurationen som data.
method
- Type:
string - Default:
"GET"
HTTP-metoden, f.eks. "GET", "POST" eller "PATCH". Det er en template, der får konfigurationen som data, så metoden kan afhænge af om der redigeres, f.eks. "<%= edit ? 'PATCH' : 'POST' %>".
dataType
- Type:
string
Hvordan svaret fra servicen læses. Kan være "json" eller "jsonp". Ved "GET" bruges "jsonp", hvis intet er angivet. Ved andre metoder læses svaret som JSON, hvis servicen svarer med JSON, og ellers som tekst.
callbackparam
- Type:
string
Navnet på den parameter, der skal indeholde navnet på JSONP-callbacken. Bruges kun, når dataType er "jsonp".
contentType
- Type:
string
Ved "POST" og "PATCH" sendes data som JSON med denne Content-Type, f.eks. "application/json". Er contentType ikke angivet, sendes data som almindelige formulardata.
headers
- Type:
object
Ekstra HTTP-headers, der sendes med, f.eks.:
json
"headers": {
"prefer": "return=minimal"
}type
- Type:
string
Angiver hvilken type service data sendes til. Det påvirker hvilke ekstra parametre, der sendes med, og hvordan svaret valideres.
"esrijson": Senderf=jsonog felterne somfeaturestil en ArcGIS service. Et tegnet punkt sendes med som geometri."datasourcejson": Senderjsoncallback."djangojson": Senderformatmed værdien fradataType.
Andre værdier, f.eks. "json", sender blot felterne som parametre.
params
- Type:
object
Faste parametre, der altid sendes med, ud over felterne.
ignoreRegID
- Type:
boolean - Default:
false
Som standard sendes parameteren regid med et tilfældigt ID, der er det samme for alle indsendelser fra samme besøg. Det kan bruges til at se, om den samme bruger har sendt flere gange. Sæt til true for ikke at sende regid.
validateresponse
- Type:
boolean - Default:
false
Tjek om servicen har gemt data korrekt, før succesbeskeden vises. Gælder kun for type "datasourcejson" og "esrijson". Hvis svaret viser en fejl, vises fejlbeskeden i stedet.
saveEachFeature
- Type:
boolean - Default:
false
Bruges sammen med et map felt med multipleFeatures. Hver tegnet geometri sendes som sin egen indsendelse med de værdier, der var udfyldt, da den blev tegnet. Er der ikke tegnet noget, sendes én indsendelse med wkt sat til POINT(0 0).
message
- Type:
object
HTML-beskeder, der vises når formularen sendes. Alle tre er templates, der får felternes værdier og svaret fra servicen som data.
loading: Vises mens data sendes.success: Vises når data er gemt.error: Vises hvis data ikke kunne gemmes. Der tilføjes automatisk en "Prøv igen" knap.
json
"message": {
"success": "<h2>Tak, <%= name %></h2>Vi har modtaget din henvendelse.",
"error": "<h2>Noget gik galt</h2>Din henvendelse er ikke registreret."
}repeatLink
- Type:
object
Viser en knap i succesbeskeden, så brugeren kan udfylde formularen igen.
text: Teksten på knappen.maxCount: Hvor mange gange formularen højst kan udfyldes. Default100.
redirect
- Type:
object
Send brugeren videre til en anden side, når formularen er sendt.
success: URL, der åbnes når data er gemt.error: URL, der åbnes hvis data ikke kunne gemmes.
data
- Type:
object
Hent en eksisterende feature og udfyld felterne med dens værdier, så formularen kan bruges til at redigere. Felterne udfyldes med værdierne fra den første feature ud fra feltets name. Samtidig sættes edit til true, så det kan bruges i submitButtonText, method og host.
host: URL til data. Det er en template, der får værdierne fraparamNames.paramNames: Parametre fra URL'en ellerdata-widget-...attributter, der kan bruges ihost.type: Formatet på data, f.eks."geojson".dataType:"json"(default) eller"jsonp".params: Ekstra parametre til kaldet.
I dette eksempel hentes en feature ud fra URL-parameteren id, f.eks. ?id=42:
json
"data": {
"host": "https://example.com/api/features/<%= id %>",
"type": "geojson",
"paramNames": {
"id": "id"
}
}embedMap
- Type:
boolean - Default:
true
Ved et map felt flyttes kortet ind i formularen. Sæt til false, hvis kortet skal blive stående, hvor det er.
buttonIndex
- Type:
number - Default:
0
Hvis der er flere komponenter med knapper i kortet, så bliver de tilføjet i en tilfældig rækkefølge. Ved at angive buttonIndex er det muligt at bestemme rækkefølgen. Laveste index kommer først. Hvis to knapper har samme index vil det være tilfældigt hvilken der kommer først.
buttonIndex bruges til fortryd-knappen ved et map felt med multipleFeatures.undo.
Felter
Alle felter kan have disse egenskaber.
name
- Type:
string
Navnet på den parameter, som værdien sendes med. Feltet kan også udfyldes fra en URL-parameter eller en data-widget-... attribut med samme navn.
nameAlt
- Type:
string
Alternativt name attribut på HTML-elementet. Det påvirker ikke, hvad der sendes.
type
- Type:
string
Hvilken type felt. Se felttyper.
label
- Type:
string
Teksten, der vises ved feltet. Ved type "text" er det selve teksten.
isRequired
- Type:
boolean - Default:
false
Feltet skal udfyldes, før formularen kan sendes. Ved en checkbox skal den være krydset af. Feltet markeres med *.
errorMessage
- Type:
string
Fejlteksten, der vises ved feltet, når det ikke er udfyldt korrekt. Hvis den ikke er angivet, vises "skal udfyldes" for et påkrævet felt, og ved email og tel en tekst, der forklarer formatet.
regexp
- Type:
string
Et regulært udtryk, som værdien skal opfylde. Bemærk at det også tjekkes, når feltet er tomt.
json
{ "name": "cvr", "type": "input", "label": "CVR-nummer", "regexp": "^\\d{8}$" }value
- Type:
string | number | boolean
Startværdi for feltet.
hidden
- Type:
boolean | string
Skjul feltet. Feltet sendes stadig med. Angives en template, vises feltet, når der redigeres og templaten ikke giver "true" for den hentede feature.
ignore
- Type:
boolean - Default:
false
Feltet sendes ikke med. Kan f.eks. bruges til en checkbox med samtykke, der skal krydses af, men ikke gemmes.
className
- Type:
string
En eller flere CSS-klasser, adskilt af mellemrum, der tilføjes elementet omkring feltet.
Felttyper
Tekstfelter
Til almindelig tekst bruges "input". Derudover kan alle HTML input-typer bruges, f.eks. "number", "date", "email", "tel" og "url", samt "textarea" til længere tekst. Bemærk at "text" ikke er et inputfelt, men viser en tekst. Se text.
number: Værdien sendes som et tal.email: Når feltet er udfyldt, skal det være en gyldig e-mail med punktum efter@.tel: Når feltet er udfyldt, skal det være et telefonnummer med 8 til 15 cifre. Det må indeholde+i starten samt mellemrum, bindestreger og parenteser.
På mobil vises det tastatur, der passer til typen.
dropdown / select
Vælg én værdi fra en liste. "dropdown" og "select" er det samme.
options: Liste med valgmuligheder. Hver harlabel,valueog evt.className.placeholder: Teksten for den tomme første mulighed. Default"Vælg".
Hvis intet er valgt, sendes en tom værdi.
json
{
"name": "usertype",
"type": "dropdown",
"label": "Hvem er du?",
"isRequired": true,
"options": [
{ "label": "Privatperson", "value": 1 },
{ "label": "Virksomhed", "value": 2 }
]
}radio
Vælg én værdi med radioknapper.
options: Liste med valgmuligheder. Hver harlabel,valueog evt.className.
checkbox
En afkrydsningsboks. Sender true eller false.
autocomplete
Adressefelt med forslag fra Adressevælgeren, mens brugeren skriver. Vælges en vej, fortsætter søgningen, så brugeren kan skrive husnummeret.
Der sendes to parametre: name med adressen og name_wkt med adressens position som WKT.
ignoreValidAddress: Sæt tiltruefor at sende den indtastede tekst, uden at brugeren skal vælge en adresse fra listen.ignoreWKT: Sæt tiltruefor ikke at sendename_wkt.sourceoptions: Ekstra parametre til Adressevælgeren, f.eks.{ "kommunekode": "0101" }.
map
Gem en geometri, som brugeren tegner i kortet, f.eks. med draw. Kortet flyttes ind i formularen, medmindre embedMap er false.
format:"wkt"(default) sender geometrien som WKT."json"sender den som GeoJSON.layer: Laget, som geometrien vises i ved redigering.conditions: Tegninger gemmes kun, hvis andre felter opfylder et regulært udtryk, f.eks.{ "type": { "regexp": "^(1|2)$" } }.multipleFeatures: Tillad flere geometrier.layer: Laget, som de tegnede geometrier vises i.max: Det højeste antal geometrier.fieldFilter: Navnet på et felt.maxgælder så pr. værdi i det felt.undo: Vis en knap i kortet, der fjerner den seneste geometri.
location
Brugerens aktuelle position. Hvis positionen ikke er tilgængelig, vises en besked med en "Prøv igen" knap.
paramNames: Navnene på de to parametre for længde- og breddegrad. Default["name_lon", "name_lat"].noLocationText: Beskeden, der vises, når positionen ikke er tilgængelig.
text
Viser en tekst i formularen. Teksten angives i label.
template: En template, der danner teksten ud fra de hentede data ved redigering.
ip
Sender brugerens IP-adresse. Feltet vises ikke.
host: URL til en service, der svarer med{ "ip": "..." }.
Events
Formularen sender to events, som kan bruges via WidgetAPI:
formsuccess: Når data er gemt.formserror: Når data ikke kunne gemmes.
Eksempler
Eksempler, der bruger denne komponent: