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:243 |
autoCommit? | boolean | Commit variable change automatically for resizing / cleaning (used for testing) * | src/use-lunatic/type.ts:286 |
autoSuggesterLoading? | boolean | Enable the preemptive loading of suggester data on Lunatic initialization. Default false | src/use-lunatic/type.ts:236 |
componentsOptions? | object | Options that can be set to override default component behaviour. | src/use-lunatic/type.ts:270 |
componentsOptions.detailAlwaysDisplayed? | boolean | Set the details ("autre précisez") as always displayed (even if the related "other" modality is not currently selected). Since 3.4.9 Default false | src/use-lunatic/type.ts:277 |
componentsOptions.disableRosterForLoopDeleteRowButton? | boolean | Set the "remove row" button as disabled in roster for loop. Since 3.7.5 Default false | src/use-lunatic/type.ts:283 |
disableFilters? | boolean | Ignore filters. Default false | src/use-lunatic/type.ts:192 |
disableFiltersDescription? | boolean | Disable filters description. Default true | src/use-lunatic/type.ts:198 |
dontKnowButton? | string | "Don't know" button label. | src/use-lunatic/type.ts:259 |
features? | ("MD" | "VTL")[] | Enable VTL and Markdown support. | src/use-lunatic/type.ts:201 |
getReferentiel? | (name) => Promise<IndexEntry[]> | Function called to fetch nomenclatures used by the suggesters. | src/use-lunatic/type.ts:238 |
initialPage? | PageTag | Starting page at launch. Default '1' | src/use-lunatic/type.ts:229 |
lastReachedPage? | PageTag | Furthest page the user ever reached. | src/use-lunatic/type.ts:231 |
logger? | LunaticLogger | - | src/use-lunatic/type.ts:268 |
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:219 |
missing? | boolean | Enable missing system. Default false | src/use-lunatic/type.ts:253 |
missingShortcut? | object | Keyboard shortcut that triggers missing buttons. | src/use-lunatic/type.ts:257 |
missingShortcut.dontKnow | string | - | src/use-lunatic/type.ts:257 |
missingShortcut.refused | string | - | src/use-lunatic/type.ts:257 |
missingStrategy? | () => void | Function triggered when a missing button is clicked. | src/use-lunatic/type.ts:255 |
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:209 |
onVariableChange? | (event) => void | - | src/use-lunatic/type.ts:210 |
preferences? | ["COLLECTED"] | - | src/use-lunatic/type.ts:202 |
refusedButton? | string | "Refused" button label. | src/use-lunatic/type.ts:261 |
savingType? | "COLLECTED" | Key in which the data is saved. Default "COLLECTED" | src/use-lunatic/type.ts:207 |
shortcut? | boolean | Enable keyboard shortcuts for checkboxes, radio buttons and missing buttons. Default false | src/use-lunatic/type.ts:224 |
trackChanges? | boolean | Enable change tracking to keep a track of what variable changed (allow using getChangedData()). Default false | src/use-lunatic/type.ts:267 |
withOverview? | boolean | Enable overview system. Default false | src/use-lunatic/type.ts:248 |