Variable: useQuestionnaireResponseStore
constuseQuestionnaireResponseStore:StoreApi<QuestionnaireResponseStoreType> &object
QuestionnaireResponse state management store which contains all properties and methods to manage the state of the questionnaire. This is the React version of the store which can be used as React hooks in React functional components.
Type Declaration
use
use:
object
use.buildSourceResponse()
buildSourceResponse: () => (
response) =>void
Returns
(
response):void
Parameters
| Parameter | Type |
|---|---|
response | QuestionnaireResponse |
Returns
void
use.destroySourceResponse()
destroySourceResponse: () => () =>
void
Returns
():
void
Returns
void
use.formChangesHistory()
formChangesHistory: () => (
Diff<QuestionnaireResponse,QuestionnaireResponse>[] |null)[]
Returns
(Diff<QuestionnaireResponse, QuestionnaireResponse>[] | null)[]
use.highlightRequiredItems()
highlightRequiredItems: () => () =>
void
Returns
():
void
Returns
void
use.invalidItems()
invalidItems: () =>
Record<string,OperationOutcome>
Returns
Record<string, OperationOutcome>
use.key()
key: () =>
string
Returns
string
use.requiredItemsIsHighlighted()
requiredItemsIsHighlighted: () =>
boolean
Returns
boolean
use.responseHasErrors()
responseHasErrors: () =>
boolean
Returns
boolean
use.responseIsValid()
responseIsValid: () =>
boolean
Returns
boolean
use.setUpdatableResponseAsEmpty()
setUpdatableResponseAsEmpty: () => (
clearedResponse) =>void
Returns
(
clearedResponse):void
Parameters
| Parameter | Type |
|---|---|
clearedResponse | QuestionnaireResponse |
Returns
void
use.setUpdatableResponseAsSaved()
setUpdatableResponseAsSaved: () => (
savedResponse) =>void
Returns
(
savedResponse):void
Parameters
| Parameter | Type |
|---|---|
savedResponse | QuestionnaireResponse |
Returns
void
use.sourceResponse()
sourceResponse: () =>
QuestionnaireResponse
Returns
QuestionnaireResponse
use.updatableResponse()
updatableResponse: () =>
QuestionnaireResponse
Returns
QuestionnaireResponse
use.updatableResponseItems()
updatableResponseItems: () =>
Record<string,QuestionnaireResponseItem[]>
Returns
Record<string, QuestionnaireResponseItem[]>
use.updateResponse()
updateResponse: () => (
updatedResponse,isInitialUpdate) =>void
Returns
(
updatedResponse,isInitialUpdate):void
Parameters
| Parameter | Type |
|---|---|
updatedResponse | QuestionnaireResponse |
isInitialUpdate | boolean |
Returns
void
use.validateResponse()
validateResponse: () => (
questionnaire,updatedResponse) =>void
Returns
(
questionnaire,updatedResponse):void
Parameters
| Parameter | Type |
|---|---|
questionnaire | Questionnaire |
updatedResponse | QuestionnaireResponse |
Returns
void
See
- QuestionnaireResponseStoreType for available properties and methods.
- questionnaireResponseStore for the vanilla store.