Type Alias: LunaticOptions
LunaticOptions =
object
Defined in: src/use-lunatic/type.ts:187
Specific behaviour options defined in the useLunatic hook.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
activeControls? | boolean | Enable data controls (form validation). (default: false) | src/use-lunatic/type.ts:221 |
autoCommit? | boolean | Commit variable change automatically for resizing / cleaning (used for testing) * | src/use-lunatic/type.ts:239 |
autoSuggesterLoading? | boolean | Enable the preemptive loading of suggester data on Lunatic initialization. (default: false) | src/use-lunatic/type.ts:217 |
componentsOptions? | object | - | src/use-lunatic/type.ts:237 |
componentsOptions.detailAlwaysDisplayed? | boolean | - | src/use-lunatic/type.ts:237 |
disableFilters? | boolean | Ignore filters. (default: false) | src/use-lunatic/type.ts:189 |
disableFiltersDescription? | boolean | Disable filters description. (default: true) | src/use-lunatic/type.ts:192 |
dontKnowButton? | string | "Don't know" button label. | src/use-lunatic/type.ts:231 |
features? | ("MD" | "VTL")[] | Enable VTL and Markdown support. | src/use-lunatic/type.ts:195 |
getReferentiel? | (name) => Promise<IndexEntry[]> | Function called to fetch nomenclatures used by the suggesters. | src/use-lunatic/type.ts:219 |
initialPage? | PageTag | Starting page at launch. (default: "1") | src/use-lunatic/type.ts:213 |
lastReachedPage? | PageTag | Furthest page the user ever reached. | src/use-lunatic/type.ts:215 |
logger? | LunaticLogger | - | src/use-lunatic/type.ts:236 |
management? | boolean | Not yet implemented. Enable management mode which allow to handle multiple states of the same variable (used by recovery positions). The administrator can switch between COLLECTED, EDITED, INPUTTED modes. (default: false) | src/use-lunatic/type.ts:209 |
missing? | boolean | Enable missing system. (default: false) | src/use-lunatic/type.ts:225 |
missingShortcut? | object | Keyboard shortcut that triggers missing buttons. | src/use-lunatic/type.ts:229 |
missingShortcut.dontKnow | string | - | src/use-lunatic/type.ts:229 |
missingShortcut.refused | string | - | src/use-lunatic/type.ts:229 |
missingStrategy? | () => void | Function triggered when a missing button is clicked. | src/use-lunatic/type.ts:227 |
onChange? | LunaticChangesHandler | Function called when a variable is changed by a user input (must be memoized as it is used in dependency of a useCallback by the library). | src/use-lunatic/type.ts:200 |
onVariableChange? | (event) => void | - | src/use-lunatic/type.ts:201 |
preferences? | ["COLLECTED"] | - | src/use-lunatic/type.ts:196 |
refusedButton? | string | "Refused" button label. | src/use-lunatic/type.ts:233 |
savingType? | "COLLECTED" | Key in which the data is saved. (default: "COLLECTED") | src/use-lunatic/type.ts:198 |
shortcut? | boolean | Enable keyboard shortcuts for checkboxes, radio buttons and missing buttons (default: false). | src/use-lunatic/type.ts:211 |
trackChanges? | boolean | Enable change tracking to keep a track of what variable changed (allow using getChangedData()). (default: false) | src/use-lunatic/type.ts:235 |
withOverview? | boolean | Enable overview system. (default: false) | src/use-lunatic/type.ts:223 |