Skip to content

Instantly share code, notes, and snippets.

@kwltrs

kwltrs/ffe-react-doc.json

Created November 10, 2020 10:19
Show Gist options
  • Save kwltrs/527efaffd02f14d286ca4de0ec6762a0 to your computer and use it in GitHub Desktop.
Save kwltrs/527efaffd02f14d286ca4de0ec6762a0 to your computer and use it in GitHub Desktop.
Download ZIP
FFE react doc
Raw
ffe-react-doc.json
{
"packages/ffe-accordion-react/src/Accordion.js": {
"description": "",
"displayName": "Accordion",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "Accordion items"
},
"headingLevel": {
"type": {
"name": "enum",
"value": [
{
"value": "1",
"computed": false
},
{
"value": "2",
"computed": false
},
{
"value": "3",
"computed": false
},
{
"value": "4",
"computed": false
},
{
"value": "5",
"computed": false
},
{
"value": "6",
"computed": false
}
]
},
"required": true,
"description": "The level of headings in the AccordionItems"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Class assigned the container"
}
}
},
"packages/ffe-accordion-react/src/AccordionItem.js": {
"description": "",
"methods": []
},
"packages/ffe-account-selector-react/src/components/account-selector/AccountSelector.js": {
"description": "",
"displayName": "AccountSelector",
"methods": [
{
"name": "renderSuggestion",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "account",
"type": null
}
],
"returns": null
},
{
"name": "assignBaseSelectorRef",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "baseSelector",
"type": null
}
],
"returns": null
},
{
"name": "renderNoMatches",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "onAccountSelect",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "account",
"type": null
}
],
"returns": null
},
{
"name": "onInputChange",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "value",
"type": null
}
],
"returns": null
},
{
"name": "onSuggestionSelect",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "suggestion",
"type": null
}
],
"returns": null
},
{
"name": "filterSuggestions",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
}
],
"props": {
"accounts": {
"type": {
"name": "arrayOf",
"value": {
"name": "custom",
"raw": "Account"
}
},
"required": false,
"description": "Array of objects:\n {\n accountNumber: string.isRequired,\n balance: number,\n currencyCode: string.\n name: string.isRequired,\n }"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"id": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"locale": {
"type": {
"name": "custom",
"raw": "Locale.isRequired"
},
"required": false,
"description": "'nb', 'nn', or 'en'"
},
"noMatches": {
"type": {
"name": "string"
},
"required": false,
"description": "Overrides default string for all locales."
},
"onAccountSelected": {
"type": {
"name": "func"
},
"required": true,
"description": "Called when an account is clicked (or Enter is pressed when highlighted)"
},
"onChange": {
"type": {
"name": "func"
},
"required": true,
"description": "Called on changes in the input field"
},
"selectedAccount": {
"type": {
"name": "custom",
"raw": "Account"
},
"required": false,
"description": ""
},
"showBalance": {
"type": {
"name": "bool"
},
"required": false,
"description": "Default true."
},
"value": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"readOnly": {
"type": {
"name": "bool"
},
"required": false,
"description": "Disables the input-field. Useful when shown in native apps,\nwhere the textual input and keyboard can be distracting."
},
"highCapacity": {
"type": {
"name": "bool"
},
"required": false,
"description": "For situations where AccountSelector might be populated with hundreds of accounts\nuses react-window for performance optimization, default false"
}
}
},
"packages/ffe-account-selector-react/src/components/account-selector-multi/AccountSelectorMulti.js": {
"description": "",
"displayName": "AccountSelectorMulti",
"methods": [
{
"name": "filterSuggestions",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "value",
"type": null
}
],
"returns": null
},
{
"name": "onSuggestionSelect",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "suggestion",
"type": null
}
],
"returns": null
},
{
"name": "renderSuggestion",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "account",
"type": null
}
],
"returns": null
},
{
"name": "onBlur",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "onDone",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "renderSuggestionDetails",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "listHeight",
"type": null
}
],
"returns": null
},
{
"name": "onKeyDown",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "event",
"type": null
}
],
"returns": null
}
],
"props": {
"accounts": {
"type": {
"name": "arrayOf",
"value": {
"name": "custom",
"raw": "Account"
}
},
"required": false,
"description": "Array of objects:\n {\n accountNumber: string.isRequired,\n balance: number,\n currencyCode: string.\n name: string.isRequired,\n }"
},
"id": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"isLoading": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
"locale": {
"type": {
"name": "custom",
"raw": "Locale.isRequired"
},
"required": false,
"description": "'nb', 'nn', or 'en'"
},
"noMatches": {
"type": {
"name": "string"
},
"required": false,
"description": "Overrides default string for all locales."
},
"onAccountSelected": {
"type": {
"name": "func"
},
"required": true,
"description": "Called when an account is clicked"
},
"onBlur": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"onSelectAll": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "() => {}",
"computed": false
}
},
"selectedAccounts": {
"type": {
"name": "arrayOf",
"value": {
"name": "custom",
"raw": "Account"
}
},
"required": false,
"description": "Array of objects:\n {\n accountNumber: string.isRequired,\n balance: number,\n currencyCode: string.\n name: string.isRequired,\n }",
"defaultValue": {
"value": "[]",
"computed": false
}
},
"showSelectAllOption": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
"value": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"highCapacity": {
"type": {
"name": "bool"
},
"required": false,
"description": "For situations where AccountSelector might be populated with hundreds of accounts\nuses react-window for performance optimization, default false"
}
}
},
"packages/ffe-account-selector-react/src/components/base-selector/BaseSelector.js": {
"description": "",
"displayName": "BaseSelector",
"methods": [
{
"name": "_onSuggestionListChange",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "getSuggestionListHeight",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "setFocus",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "getInputHeight",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "onInputChange",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "val",
"type": null
}
],
"returns": null
},
{
"name": "onFocus",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "onBlur",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "onClick",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "onInputReset",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "showOrHideSuggestions",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "show",
"type": null
},
{
"name": "cb",
"type": null
}
],
"returns": null
},
{
"name": "setNextHighlighted",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "setPreviousHighlighted",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "setFirstHighlighted",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "setLastHighlighted",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "onInputKeyDown",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "event",
"type": null
}
],
"returns": null
}
],
"props": {
"suggestions": {
"type": {
"name": "arrayOf",
"value": {
"name": "object"
}
},
"required": true,
"description": ""
},
"suggestionFilter": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"onSelect": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"value": {
"type": {
"name": "string"
},
"required": false,
"description": "",
"defaultValue": {
"value": "''",
"computed": false
}
},
"locale": {
"type": {
"name": "custom",
"raw": "Locale.isRequired"
},
"required": false,
"description": ""
},
"shouldHideSuggestionsOnSelect": {
"type": {
"name": "bool"
},
"required": true,
"description": ""
},
"shouldSelectHighlightedOnTab": {
"type": {
"name": "bool"
},
"required": true,
"description": ""
},
"shouldHideSuggestionsOnBlur": {
"type": {
"name": "bool"
},
"required": true,
"description": ""
},
"shouldHideSuggestionsOnReset": {
"type": {
"name": "bool"
},
"required": true,
"description": ""
},
"shouldShowSuggestionsOnFocus": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "true",
"computed": false
}
},
"onSuggestionSelect": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"onChange": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "Function.prototype",
"computed": true
}
},
"onBlur": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "Function.prototype",
"computed": true
}
},
"onClick": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "Function.prototype",
"computed": true
}
},
"onReset": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "Function.prototype",
"computed": true
}
},
"onFocus": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "Function.prototype",
"computed": true
}
},
"onSuggestionListChange": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "Function.prototype",
"computed": true
}
},
"placeholder": {
"type": {
"name": "string"
},
"required": false,
"description": "",
"defaultValue": {
"value": "''",
"computed": false
}
},
"ariaInvalid": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
"suggestionsHeightMax": {
"type": {
"name": "number"
},
"required": false,
"description": ""
},
"id": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"name": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"readOnly": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"highCapacity": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-account-selector-react/src/subcomponents/account/AccountDetails.js": {
"description": "",
"displayName": "AccountDetails",
"methods": [],
"props": {
"account": {
"type": {
"name": "custom",
"raw": "Account.isRequired"
},
"required": false,
"description": ""
},
"locale": {
"type": {
"name": "custom",
"raw": "Locale.isRequired"
},
"required": false,
"description": ""
},
"showBalance": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "true",
"computed": false
}
}
}
},
"packages/ffe-account-selector-react/src/subcomponents/account/AccountNoMatch.js": {
"description": "",
"displayName": "AccountNoMatch",
"methods": [],
"props": {
"value": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"locale": {
"type": {
"name": "custom",
"raw": "Locale.isRequired"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-account-selector-react/src/subcomponents/account/AccountSuggestion.js": {
"description": "",
"displayName": "AccountSuggestionItem",
"methods": [],
"props": {
"account": {
"type": {
"name": "custom",
"raw": "Account.isRequired"
},
"required": false,
"description": ""
},
"locale": {
"type": {
"name": "custom",
"raw": "Locale.isRequired"
},
"required": false,
"description": ""
},
"showBalance": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "true",
"computed": false
}
}
}
},
"packages/ffe-account-selector-react/src/subcomponents/account/AccountSuggestionMulti.js": {
"description": "",
"displayName": "AccountSuggestionMulti",
"methods": [],
"props": {
"account": {
"type": {
"name": "custom",
"raw": "Account.isRequired"
},
"required": false,
"description": ""
},
"locale": {
"type": {
"name": "custom",
"raw": "Locale.isRequired"
},
"required": false,
"description": ""
},
"selected": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-account-selector-react/src/subcomponents/input-field/InputField.js": {
"description": "",
"displayName": "InputField",
"methods": [],
"props": {
"onChange": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"onKeyDown": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"value": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"onReset": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"isSuggestionsShowing": {
"type": {
"name": "bool"
},
"required": true,
"description": ""
},
"id": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"readOnly": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
"placeholder": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"onBlur": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "() => {}",
"computed": false
}
},
"onFocus": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "() => {}",
"computed": false
}
},
"onClick": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"ariaInvalid": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
"inputFieldRef": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "() => {}",
"computed": false
}
},
"highlightedIndex": {
"type": {
"name": "number"
},
"required": false,
"description": ""
},
"suggestionListId": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"name": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"locale": {
"type": {
"name": "custom",
"raw": "Locale.isRequired"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-account-selector-react/src/subcomponents/suggestion/SuggestionItem.js": {
"description": "",
"displayName": "SuggestionItem",
"methods": [],
"props": {
"item": {
"type": {
"name": "object"
},
"required": true,
"description": ""
},
"id": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"isHighlighted": {
"type": {
"name": "bool"
},
"required": true,
"description": ""
},
"render": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"onSelect": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"refHighlightedSuggestion": {
"type": {
"name": "func"
},
"required": true,
"description": ""
}
}
},
"packages/ffe-account-selector-react/src/subcomponents/suggestion/SuggestionList.js": {
"description": "",
"displayName": "SuggestionList",
"methods": [],
"props": {
"suggestions": {
"type": {
"name": "arrayOf",
"value": {
"name": "object"
}
},
"required": true,
"description": ""
},
"highlightedIndex": {
"type": {
"name": "number"
},
"required": true,
"description": ""
},
"renderSuggestion": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"renderNoMatches": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "() => {}",
"computed": false
}
},
"id": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"isLoading": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-account-selector-react/src/subcomponents/suggestion/SuggestionListContainer.js": {
"description": "",
"displayName": "SuggestionListContainer",
"methods": [
{
"name": "refHighlightedSuggestion",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "suggestionEl",
"type": null
}
],
"returns": null
},
{
"name": "_setScrollPos",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "pos",
"type": null
}
],
"returns": null
},
{
"name": "setScrollPosStart",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "setScrollPosEnd",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "setScrollPosNext",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "setScrollPosPrevious",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
}
],
"props": {
"highlightedIndex": {
"type": {
"name": "number"
},
"required": true,
"description": ""
},
"heightMax": {
"type": {
"name": "number"
},
"required": false,
"description": "",
"defaultValue": {
"value": "300",
"computed": false
}
},
"autoHeight": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "true",
"computed": false
}
}
}
},
"packages/ffe-account-selector-react/src/subcomponents/suggestion/SuggestionListStatusBar.js": {
"description": "",
"displayName": "StatusBar",
"methods": [],
"props": {
"onDone": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"renderSelectionStatus": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"labelDoneButton": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"style": {
"type": {
"name": "object"
},
"required": true,
"description": ""
}
}
},
"packages/ffe-account-selector-react/src/subcomponents/suggestion-high-capacity/SuggestionItem.js": {
"description": "",
"displayName": "SuggestionItem",
"methods": [],
"props": {
"item": {
"type": {
"name": "object"
},
"required": true,
"description": ""
},
"id": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"isHighlighted": {
"type": {
"name": "bool"
},
"required": true,
"description": ""
},
"render": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"onSelect": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"refHighlightedSuggestion": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"style": {
"type": {
"name": "object"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-account-selector-react/src/subcomponents/suggestion-high-capacity/SuggestionList.js": {
"description": "",
"displayName": "SuggestionList",
"methods": [],
"props": {
"suggestions": {
"type": {
"name": "arrayOf",
"value": {
"name": "object"
}
},
"required": true,
"description": ""
},
"highlightedIndex": {
"type": {
"name": "number"
},
"required": true,
"description": ""
},
"renderSuggestion": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"renderNoMatches": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "() => {}",
"computed": false
}
},
"id": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"isLoading": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
"refList": {
"type": {
"name": "object"
},
"required": false,
"description": ""
},
"height": {
"type": {
"name": "number"
},
"required": false,
"description": "",
"defaultValue": {
"value": "300",
"computed": false
}
},
"itemSize": {
"type": {
"name": "number"
},
"required": false,
"description": "",
"defaultValue": {
"value": "55",
"computed": false
}
}
}
},
"packages/ffe-account-selector-react/src/subcomponents/suggestion-high-capacity/SuggestionListContainer.js": {
"description": "",
"displayName": "SuggestionListContainer",
"methods": [
{
"name": "refHighlightedSuggestion",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "suggestionEl",
"type": null
}
],
"returns": null
},
{
"name": "_setScrollPos",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "pos",
"type": null
}
],
"returns": null
},
{
"name": "setScrollPosStart",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "setScrollPosEnd",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "setScrollPosNext",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "setScrollPosPrevious",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "handleScroll",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "{ target }",
"type": null
}
],
"returns": null
}
],
"props": {
"highlightedIndex": {
"type": {
"name": "number"
},
"required": true,
"description": ""
},
"heightMax": {
"type": {
"name": "number"
},
"required": false,
"description": "",
"defaultValue": {
"value": "300",
"computed": false
}
},
"autoHeight": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "true",
"computed": false
}
}
}
},
"packages/ffe-account-selector-react/src/subcomponents/suggestion-high-capacity/SuggestionListStatusBar.js": {
"description": "",
"displayName": "StatusBar",
"methods": [],
"props": {
"onDone": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"renderSelectionStatus": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"labelDoneButton": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"style": {
"type": {
"name": "object"
},
"required": true,
"description": ""
}
}
},
"packages/ffe-buttons-react/src/ActionButton.js": {
"description": "",
"displayName": "ActionButton",
"methods": [],
"props": {
"ariaLoadingMessage": {
"type": {
"name": "string"
},
"required": false,
"description": "Aria label for loading indicator"
},
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The button label"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Extra class names"
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": "Condensed modifier. Use in condensed designs"
},
"disabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "Disable a button in certain situations"
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The rendered element, like an `<a />` or `<Link />`"
},
"ghost": {
"type": {
"name": "bool"
},
"required": false,
"description": "Applies the ghost modifier if true.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"innerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the button element"
},
"isLoading": {
"type": {
"name": "bool"
},
"required": false,
"description": "Shows a loader if true"
},
"leftIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the left of the label"
},
"rightIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the right of the label"
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-buttons-react/src/BackButton.js": {
"description": "",
"displayName": "BackButton",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The button label"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Extra class names"
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The rendered element, like an `<a />` or `<Link />`"
},
"innerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the button element"
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-buttons-react/src/BaseButton.js": {
"description": "Internal component",
"displayName": "BaseButton",
"methods": [],
"props": {
"ariaLoadingMessage": {
"type": {
"name": "string"
},
"required": false,
"description": "Aria label for loading indicator",
"defaultValue": {
"value": "'Vennligst vent'",
"computed": false
}
},
"buttonType": {
"type": {
"name": "enum",
"value": [
{
"value": "'action'",
"computed": false
},
{
"value": "'primary'",
"computed": false
},
{
"value": "'secondary'",
"computed": false
},
{
"value": "'shortcut'",
"computed": false
},
{
"value": "'task'",
"computed": false
}
]
},
"required": false,
"description": "Enum of supported prop types. Used internally only.\n@ignore"
},
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The button label"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Extra class names"
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": "Condensed modifier. Use in condensed designs"
},
"disabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "Disable a button in certain situations"
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The rendered element, like an `<a />` or `<Link />`",
"defaultValue": {
"value": "'button'",
"computed": false
}
},
"innerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the button element"
},
"isLoading": {
"type": {
"name": "bool"
},
"required": false,
"description": "Shows a loader if true"
},
"leftIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the left of the label"
},
"rightIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the right of the label"
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-buttons-react/src/ButtonGroup.js": {
"description": "",
"displayName": "ButtonGroup",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Extra class name applied in addition to the FFE classes"
},
"thin": {
"type": {
"name": "bool"
},
"required": false,
"description": "Applies the thin modifier to remove margins"
},
"inline": {
"type": {
"name": "bool"
},
"required": false,
"description": "Applies the inline modifier to make all child buttons inline"
}
}
},
"packages/ffe-buttons-react/src/ExpandButton.js": {
"description": "",
"displayName": "ExpandButton",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "The button label"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Extra class names"
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The rendered element, like an `<a />` or `<Link />`",
"defaultValue": {
"value": "'button'",
"computed": false
}
},
"closeLabel": {
"type": {
"name": "string"
},
"required": false,
"description": "An accessible label for the close-button, only shown in the \"isExpanded\" state",
"defaultValue": {
"value": "'Lukk'",
"computed": false
}
},
"leftIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the left of the label"
},
"rightIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the right of the label"
},
"innerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the button element"
},
"isExpanded": {
"type": {
"name": "bool"
},
"required": true,
"description": "When true the component will render a circle with an X indicating whatever is controlled is in an expanded state."
},
"onClick": {
"type": {
"name": "func"
},
"required": true,
"description": "Use to listen for clicks and toggle the `isExpanded` property together with whatever it is you're expanding."
}
}
},
"packages/ffe-buttons-react/src/InlineBaseButton.js": {
"description": "Internal component\n@ignore",
"displayName": "InlineBaseButton",
"methods": [],
"props": {
"buttonType": {
"type": {
"name": "enum",
"value": [
{
"value": "'tertiary'",
"computed": false
},
{
"value": "'back'",
"computed": false
},
{
"value": "'expand'",
"computed": false
}
]
},
"required": false,
"description": "Enum of supported prop types. Used internally only.\n@ignore"
},
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "The button label"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Extra class names"
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "string"
},
{
"name": "func"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The rendered element, like an `<a />` or `<Link />`",
"defaultValue": {
"value": "'button'",
"computed": false
}
},
"innerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the button element"
},
"leftIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the left of the label"
},
"rightIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the right of the label"
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-buttons-react/src/InlineExpandButton.js": {
"description": "",
"displayName": "InlineExpandButton",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "Text that should reflect the isExpanded state."
},
"innerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the button element"
},
"isExpanded": {
"type": {
"name": "bool"
},
"required": true,
"description": "When true it will indicate the button is in its open state"
},
"onClick": {
"type": {
"name": "func"
},
"required": true,
"description": "Listen for clicks to toggle the isExpanded state."
}
}
},
"packages/ffe-buttons-react/src/PrimaryButton.js": {
"description": "",
"displayName": "PrimaryButton",
"methods": [],
"props": {
"ariaLoadingMessage": {
"type": {
"name": "string"
},
"required": false,
"description": "Aria label for loading indicator"
},
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The button label"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Extra class names"
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": "Condensed modifier. Use in condensed designs"
},
"disabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "Disable a button in certain situations"
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The rendered element, like an `<a />` or `<Link />`"
},
"innerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the button element"
},
"isLoading": {
"type": {
"name": "bool"
},
"required": false,
"description": "Shows a loader if true"
},
"leftIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the left of the label"
},
"rightIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the right of the label"
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-buttons-react/src/SecondaryButton.js": {
"description": "",
"displayName": "SecondaryButton",
"methods": [],
"props": {
"ariaLoadingMessage": {
"type": {
"name": "string"
},
"required": false,
"description": "Aria label for loading indicator"
},
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The button label"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Extra class names"
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": "Condensed modifier. Use in condensed designs"
},
"disabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "Disable a button in certain situations"
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The rendered element, like an `<a />` or `<Link />`"
},
"innerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the button element"
},
"isLoading": {
"type": {
"name": "bool"
},
"required": false,
"description": "Shows a loader if true"
},
"leftIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the left of the label"
},
"rightIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the right of the label"
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-buttons-react/src/ShortcutButton.js": {
"description": "",
"displayName": "ShortcutButton",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The button label"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Extra class names"
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": "Condensed modifier. Use in condensed designs"
},
"disabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "Disable a button in certain situations"
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The rendered element, like an `<a />` or `<Link />`"
},
"innerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the button element"
},
"leftIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the left of the label"
}
}
},
"packages/ffe-buttons-react/src/TaskButton.js": {
"description": "",
"displayName": "TaskButton",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The button label"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Extra class names"
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": "Condensed modifier. Use in condensed designs"
},
"disabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "Disable a button in certain situations"
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The rendered element, like an `<a />` or `<Link />`"
},
"icon": {
"type": {
"name": "node"
},
"required": true,
"description": "Task icon, show to the left of the label"
},
"innerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the button element"
}
}
},
"packages/ffe-buttons-react/src/TertiaryButton.js": {
"description": "",
"displayName": "TertiaryButton",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The button label"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Extra class names"
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The rendered element, like an `<a />` or `<Link />`"
},
"innerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the button element"
},
"leftIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the left of the label"
},
"rightIcon": {
"type": {
"name": "node"
},
"required": false,
"description": "Icon shown to the right of the label"
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-cards-react/src/CardBase.js": {
"description": "",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"children": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The element to render the card as",
"defaultValue": {
"value": "'div'",
"computed": false
}
}
}
},
"packages/ffe-cards-react/src/IconCard/IconCard.js": {
"description": "",
"displayName": "IconCard",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"icon": {
"type": {
"name": "node"
},
"required": true,
"description": "A rendered icon"
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": "Smaller icon and less space"
},
"greyCharcoal": {
"type": {
"name": "bool"
},
"required": false,
"description": "Icon and text will all be ffe-grey-charcoal"
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The element to render the card as"
},
"children": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "node"
}
]
},
"required": false,
"description": "Function that's passed available sub-components as arguments, or regular children"
}
}
},
"packages/ffe-cards-react/src/ImageCard/ImageCard.js": {
"description": "",
"displayName": "ImageCard",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"image": {
"type": {
"name": "node"
},
"required": true,
"description": "A rendered image"
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The element to render the card as"
},
"children": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "node"
}
]
},
"required": false,
"description": "Function that's passed available sub-components as arguments, or regular children"
}
}
},
"packages/ffe-cards-react/src/LinkCard.js": {
"description": "@deprecated This card comes with an outdated design. Use one of the new cards instead.",
"displayName": "LinkCard",
"methods": [],
"props": {
"center": {
"type": {
"name": "bool"
},
"required": false,
"description": "Center the card's content horizontally"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"details": {
"type": {
"name": "node"
},
"required": false,
"description": "Bottom text - should only be used with `size=\"large\"`"
},
"elementType": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The element to render the card as. Typically `'a'`, `Link` or `'button'`",
"defaultValue": {
"value": "'a'",
"computed": false
}
},
"heading": {
"type": {
"name": "string"
},
"required": false,
"description": "Text shown at the top"
},
"icon": {
"type": {
"name": "node"
},
"required": false,
"description": "A rendered icon - will be sized appropriately"
},
"number": {
"type": {
"name": "custom",
"raw": "numberType"
},
"required": false,
"description": "An enumerating number, typically to show which \"step\" a card represents. Should be used only when `plain` is true"
},
"size": {
"type": {
"name": "enum",
"value": [
{
"value": "'medium'",
"computed": false
},
{
"value": "'large'",
"computed": false
}
]
},
"required": false,
"description": "Optional size modifiers"
},
"plain": {
"type": {
"name": "bool"
},
"required": false,
"description": "Make less \"clickable\" - works well with specifying `number` prop"
},
"status": {
"type": {
"name": "string"
},
"required": false,
"description": "Status text displayed at the top of the card with a 1 second delay"
},
"subHeading": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-cards-react/src/ProductCard.js": {
"description": "@deprecated This card comes with an outdated design. Use one of the new cards instead.",
"displayName": "ProductCard",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"details": {
"type": {
"name": "node"
},
"required": false,
"description": "Bottom text - should only be used with `size=\"large\"`"
},
"elementType": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The element to render the card as.",
"defaultValue": {
"value": "'div'",
"computed": false
}
},
"heading": {
"type": {
"name": "string"
},
"required": false,
"description": "Text shown at the top"
},
"icon": {
"type": {
"name": "node"
},
"required": false,
"description": "A rendered icon - will be sized appropriately"
},
"status": {
"type": {
"name": "string"
},
"required": false,
"description": "Status text displayed at the top of the card with a 1 second delay"
}
}
},
"packages/ffe-cards-react/src/TextCard/TextCard.js": {
"description": "",
"displayName": "TextCard",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"leftAlign": {
"type": {
"name": "bool"
},
"required": false,
"description": "Left-aligned text on the card"
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The element to render the card as"
},
"children": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "node"
}
]
},
"required": false,
"description": "Function that's passed available sub-components as arguments, or regular children"
}
}
},
"packages/ffe-cards-react/src/components/CardName.js": {
"description": "",
"displayName": "CardName",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-cards-react/src/components/ComponentBase.js": {
"description": "",
"displayName": "ComponentBase",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "",
"defaultValue": {
"value": "'p'",
"computed": false
}
},
"children": {
"type": {
"name": "node"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-cards-react/src/components/Subtext.js": {
"description": "",
"displayName": "Subtext",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-cards-react/src/components/Text.js": {
"description": "",
"displayName": "Text",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-cards-react/src/components/Title.js": {
"description": "",
"displayName": "Title",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"overflowEllipsis": {
"type": {
"name": "bool"
},
"required": false,
"description": "Disable wrapping and hide overflow with ellipsis",
"defaultValue": {
"value": "true",
"computed": false
}
}
}
},
"packages/ffe-chart-donut-react/src/ChartDonut.js": {
"description": "",
"displayName": "ChartDonut",
"methods": [],
"props": {
"firstLabel": {
"type": {
"name": "string"
},
"required": true,
"description": "Short text labeling left value, like \"empty\", \"said yes\" etc"
},
"lastLabel": {
"type": {
"name": "string"
},
"required": true,
"description": "Short text labeling right value, like \"full\", \"said no\" etc"
},
"name": {
"type": {
"name": "string"
},
"required": true,
"description": "Short text labeling the graph in total, like \"percentage\", \"voted this year\" etc"
},
"percentage": {
"type": {
"name": "number"
},
"required": true,
"description": "The percentage for the right-most value"
}
}
},
"packages/ffe-collapse-react/src/Collapse.js": {
"description": "",
"displayName": "Collapse",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"style": {
"type": {
"name": "object"
},
"required": false,
"description": ""
},
"isOpen": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"onRest": {
"type": {
"name": "func"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-context-message-react/src/ContextErrorMessage.js": {
"description": "",
"displayName": "ContextErrorMessage",
"methods": [],
"props": {
"animationLengthMs": {
"type": {
"name": "number"
},
"required": false,
"description": "",
"defaultValue": {
"value": "300",
"computed": false
}
},
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "The content shown in the context box"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Classes are added in addition to the relevant context message classes"
},
"compact": {
"type": {
"name": "bool"
},
"required": false,
"description": "Renders a more compact version of the context message",
"defaultValue": {
"value": "false",
"computed": false
}
},
"contentElementId": {
"type": {
"name": "string"
},
"required": false,
"description": "ID for the children container",
"defaultValue": {
"value": "'contentElementId'",
"computed": false
}
},
"header": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"headerElementId": {
"type": {
"name": "string"
},
"required": false,
"description": "ID for the header container",
"defaultValue": {
"value": "'headerElementId'",
"computed": false
}
},
"icon": {
"type": {
"name": "element"
},
"required": false,
"description": ""
},
"locale": {
"type": {
"name": "enum",
"computed": true,
"value": "acceptedLocales"
},
"required": false,
"description": "Decides the language of the aria-label for the close icon",
"defaultValue": {
"value": "'nb'",
"computed": false
}
},
"messageType": {
"type": {
"name": "enum",
"value": [
{
"value": "'info'",
"computed": false
},
{
"value": "'tip'",
"computed": false
},
{
"value": "'success'",
"computed": false
},
{
"value": "'error'",
"computed": false
}
]
},
"required": true,
"description": "Provided by the wrapper component"
},
"onClose": {
"type": {
"name": "func"
},
"required": false,
"description": "Callback for when the context message has been closed (after the animation)",
"defaultValue": {
"value": "() => {}",
"computed": false
}
},
"showCloseButton": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
"style": {
"type": {
"name": "object"
},
"required": false,
"description": "Styles applied to the outermost element. `height` will be overridden",
"defaultValue": {
"value": "{}",
"computed": false
}
},
"alert": {
"type": {
"name": "bool"
},
"required": false,
"description": "When false, role is not set to alert, avoids message from being read up immediately after page load. Default value is true.",
"defaultValue": {
"value": "true",
"computed": false
}
}
}
},
"packages/ffe-context-message-react/src/ContextInfoMessage.js": {
"description": "",
"displayName": "ContextInfoMessage",
"methods": []
},
"packages/ffe-context-message-react/src/ContextMessage.js": {
"description": "Base component for all four types of context messages.\n\n*Should never be used directly!*\nPlease use one of the four versions exported from this package.",
"displayName": "ContextMessage",
"methods": [
{
"name": "close",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "event",
"type": null
}
],
"returns": null
},
{
"name": "renderIcon",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
}
],
"props": {
"animationLengthMs": {
"type": {
"name": "number"
},
"required": false,
"description": "",
"defaultValue": {
"value": "300",
"computed": false
}
},
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "The content shown in the context box"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Classes are added in addition to the relevant context message classes"
},
"compact": {
"type": {
"name": "bool"
},
"required": false,
"description": "Renders a more compact version of the context message",
"defaultValue": {
"value": "false",
"computed": false
}
},
"contentElementId": {
"type": {
"name": "string"
},
"required": false,
"description": "ID for the children container",
"defaultValue": {
"value": "'contentElementId'",
"computed": false
}
},
"header": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"headerElementId": {
"type": {
"name": "string"
},
"required": false,
"description": "ID for the header container",
"defaultValue": {
"value": "'headerElementId'",
"computed": false
}
},
"icon": {
"type": {
"name": "element"
},
"required": false,
"description": ""
},
"locale": {
"type": {
"name": "enum",
"computed": true,
"value": "acceptedLocales"
},
"required": false,
"description": "Decides the language of the aria-label for the close icon",
"defaultValue": {
"value": "'nb'",
"computed": false
}
},
"messageType": {
"type": {
"name": "enum",
"value": [
{
"value": "'info'",
"computed": false
},
{
"value": "'tip'",
"computed": false
},
{
"value": "'success'",
"computed": false
},
{
"value": "'error'",
"computed": false
}
]
},
"required": true,
"description": "Provided by the wrapper component"
},
"onClose": {
"type": {
"name": "func"
},
"required": false,
"description": "Callback for when the context message has been closed (after the animation)",
"defaultValue": {
"value": "() => {}",
"computed": false
}
},
"showCloseButton": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
"style": {
"type": {
"name": "object"
},
"required": false,
"description": "Styles applied to the outermost element. `height` will be overridden",
"defaultValue": {
"value": "{}",
"computed": false
}
}
}
},
"packages/ffe-context-message-react/src/ContextSuccessMessage.js": {
"description": "",
"displayName": "ContextSuccessMessage",
"methods": []
},
"packages/ffe-context-message-react/src/ContextTipMessage.js": {
"description": "",
"displayName": "ContextTipMessage",
"methods": []
},
"packages/ffe-core-react/src/typography/DividerLine.js": {
"description": "",
"displayName": "DividerLine",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-core-react/src/typography/EmphasizedText.js": {
"description": "",
"displayName": "EmphasizedText",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-core-react/src/typography/LinkText.js": {
"description": "",
"displayName": "LinkText",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "The rendered element, like a `react-router` `<Link />`",
"defaultValue": {
"value": "'a'",
"computed": false
}
},
"underline": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "true",
"computed": false
}
}
}
},
"packages/ffe-core-react/src/typography/MicroText.js": {
"description": "",
"displayName": "MicroText",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-core-react/src/typography/Paragraph.js": {
"description": "",
"displayName": "Paragraph",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"lead": {
"type": {
"name": "bool"
},
"required": false,
"description": "Makes this paragraph a lead paragraph, typically used directly below a heading."
},
"subLead": {
"type": {
"name": "bool"
},
"required": false,
"description": "Makes this paragraph a sub-lead paragraph, typically used directly below a lead paragraph."
},
"textCenter": {
"type": {
"name": "bool"
},
"required": false,
"description": "Use if text alignment should override that of its container."
},
"textLeft": {
"type": {
"name": "bool"
},
"required": false,
"description": "Use if text alignment should override that of its container."
}
}
},
"packages/ffe-core-react/src/typography/PreformattedText.js": {
"description": "",
"displayName": "PreformattedText",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-core-react/src/typography/SmallText.js": {
"description": "",
"displayName": "SmallText",
"methods": [],
"props": {
"element": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "string"
},
{
"name": "custom",
"raw": "elementType"
}
]
},
"required": false,
"description": "",
"defaultValue": {
"value": "'span'",
"computed": false
}
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-core-react/src/typography/StrongText.js": {
"description": "",
"displayName": "StrongText",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-datepicker-react/src/calendar/ActiveDate.js": {
"description": "",
"displayName": "ActiveDate",
"methods": [
{
"name": "focusIfNeeded",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "dateClassName",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "tabIndex",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
}
],
"props": {
"date": {
"type": {
"name": "shape",
"value": {
"date": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "number"
}
],
"required": false
},
"isEnabled": {
"name": "bool",
"required": false
},
"isFocus": {
"name": "bool",
"required": false
},
"isSelected": {
"name": "bool",
"required": false
},
"isToday": {
"name": "bool",
"required": false
}
}
},
"required": true,
"description": ""
},
"headers": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"onClick": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"forceFocus": {
"type": {
"name": "bool"
},
"required": true,
"description": ""
}
}
},
"packages/ffe-datepicker-react/src/calendar/Calendar.js": {
"description": "",
"displayName": "Calendar",
"methods": [
{
"name": "keyDown",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "event",
"type": null
}
],
"returns": null
},
{
"name": "mouseClick",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "date",
"type": null
}
],
"returns": null
},
{
"name": "focusHandler",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "evt",
"type": null
}
],
"returns": null
},
{
"name": "wrapperBlurHandler",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "nextMonth",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "evt",
"type": null
}
],
"returns": null
},
{
"name": "previousMonth",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "evt",
"type": null
}
],
"returns": null
},
{
"name": "renderDate",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "date",
"type": null
},
{
"name": "index",
"type": null
}
],
"returns": null
},
{
"name": "renderWeek",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "week",
"type": null
}
],
"returns": null
},
{
"name": "renderDay",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "day",
"type": null
},
{
"name": "index",
"type": null
}
],
"returns": null
}
],
"props": {
"calendarClassName": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"escKeyHandler": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"focusOnOpen": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
"language": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"maxDate": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"minDate": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"onBlurHandler": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"onDatePicked": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"selectedDate": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-datepicker-react/src/calendar/Header.js": {
"description": "",
"displayName": "Header",
"methods": [],
"props": {
"datepickerId": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"month": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"nextMonthHandler": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"nextMonthLabel": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"previousMonthHandler": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"previousMonthLabel": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"year": {
"type": {
"name": "number"
},
"required": true,
"description": ""
}
}
},
"packages/ffe-datepicker-react/src/calendar/LeadDate.js": {
"description": "",
"displayName": "LeadDate",
"methods": [],
"props": {
"date": {
"type": {
"name": "shape",
"value": {
"timestamp": {
"name": "number",
"required": true
}
}
},
"required": true,
"description": ""
}
}
},
"packages/ffe-datepicker-react/src/datepicker/Datepicker.js": {
"description": "",
"displayName": "Datepicker",
"methods": [
{
"name": "onInputFocus",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "onError",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "type",
"type": null
}
],
"returns": null
},
{
"name": "validateDateIntervals",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "onInputBlur",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "onInputKeydown",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "evt",
"type": null
}
],
"returns": null
},
{
"name": "escKeyHandler",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "evt",
"type": null
}
],
"returns": null
},
{
"name": "globalClickHandler",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "evt",
"type": null
}
],
"returns": null
},
{
"name": "clickHandler",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "blurHandler",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "evt",
"type": null
}
],
"returns": null
},
{
"name": "divBlurHandler",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "evt",
"type": null
}
],
"returns": null
},
{
"name": "datePickedHandler",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "date",
"type": null
}
],
"returns": null
},
{
"name": "openCalendar",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "closeCalendar",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "closeCalendarSetInputFocus",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "addGlobalEventListeners",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "removeGlobalEventListeners",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "ariaInvalid",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
}
],
"props": {
"aria-invalid": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"ariaInvalid": {
"type": {
"name": "union",
"value": [
{
"name": "bool"
},
{
"name": "string"
}
]
},
"required": false,
"description": ""
},
"calendarAbove": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"hideErrors": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"onValidationComplete": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "() => {}",
"computed": false
}
},
"inputProps": {
"type": {
"name": "shape",
"value": {
"className": {
"name": "string",
"required": false
},
"id": {
"name": "string",
"required": false
}
}
},
"required": false,
"description": ""
},
"label": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"language": {
"type": {
"name": "string"
},
"required": false,
"description": "",
"defaultValue": {
"value": "'nb'",
"computed": false
}
},
"maxDate": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"minDate": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"onChange": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"onError": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"value": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"keepDisplayStateOnError": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
"fullWidth": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-datepicker-react/src/input/Input.js": {
"description": "",
"displayName": "Input",
"methods": [
{
"name": "focus",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "inputClassNames",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "extraClassNames",
"type": null
}
],
"returns": null
},
{
"name": "dateInputClassNames",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
}
],
"props": {
"aria-invalid": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"ariaInvalid": {
"type": {
"name": "union",
"value": [
{
"name": "bool"
},
{
"name": "string"
}
]
},
"required": false,
"description": ""
},
"inputProps": {
"type": {
"name": "shape",
"value": {
"className": {
"name": "string",
"required": false
}
}
},
"required": false,
"description": ""
},
"onBlur": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"onChange": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"onFocus": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"onKeyDown": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"value": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"fullWidth": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-details-list-react/src/Detail.js": {
"description": "",
"displayName": "Detail",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "A set of `DetailsContent` components to render for this row"
},
"label": {
"type": {
"name": "string"
},
"required": true,
"description": "A label for the data"
}
}
},
"packages/ffe-details-list-react/src/DetailContent.js": {
"description": "",
"displayName": "DetailContent",
"methods": [],
"props": {
"childCount": {
"type": {
"name": "number"
},
"required": false,
"description": "Internal prop used for knowing the total amount of columns, provided by `Detail`\n@ignore"
},
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "The contents of the column"
},
"index": {
"type": {
"name": "number"
},
"required": false,
"description": "Internal prop used for knowing which column is being rendered, provided by `Detail`\n@ignore"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any CSS classes that should be included on the rendered content"
},
"cta": {
"type": {
"name": "bool"
},
"required": false,
"description": "Indicate if this should be rendered as a call to action and moved to the end of the row\n@ignore"
}
}
},
"packages/ffe-details-list-react/src/DetailList.js": {
"description": "",
"displayName": "DetailList",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "A set of `Detail` components where each will be rendered as a row item"
}
}
},
"packages/ffe-dropdown-react/src/Dropdown.js": {
"description": "",
"displayName": "Dropdown",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"inline": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
},
"innerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the select element"
}
}
},
"packages/ffe-file-upload-react/src/FileItem.js": {
"description": "",
"displayName": "FileItem",
"methods": [],
"props": {
"file": {
"type": {
"name": "shape",
"value": {
"name": {
"name": "custom",
"raw": "stringType.isRequired",
"required": true
},
"document": {
"name": "object",
"required": false
},
"error": {
"name": "custom",
"raw": "stringType",
"required": false
}
}
},
"required": true,
"description": "Shape of the file type, name is required, error and document.content is optional"
},
"onFileDeleted": {
"type": {
"name": "func"
},
"required": true,
"description": "Called when the user clicks the delete button for a given file. Is called with the name of the file in question."
},
"cancelText": {
"type": {
"name": "custom",
"raw": "stringType"
},
"required": false,
"description": "Label for the cancel button"
},
"deleteText": {
"type": {
"name": "custom",
"raw": "stringType"
},
"required": false,
"description": "Label for the delete button"
}
}
},
"packages/ffe-file-upload-react/src/FileUpload.js": {
"description": "",
"displayName": "FileUpload",
"methods": [
{
"name": "setFileInputElement",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "element",
"type": null
}
],
"returns": null
},
{
"name": "triggerUploadFileNativeHandler",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "onFilesSelected",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "event",
"type": null
}
],
"returns": null
},
{
"name": "onFilesDropped",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "event",
"type": null
}
],
"returns": null
},
{
"name": "onFileDeleted",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "event",
"type": null
}
],
"returns": null
}
],
"props": {
"id": {
"type": {
"name": "custom",
"raw": "stringType.isRequired"
},
"required": false,
"description": "ID for the input field. The ID is used as a base for the label ID as well."
},
"label": {
"type": {
"name": "custom",
"raw": "stringType.isRequired"
},
"required": false,
"description": "Label for the button to trigger native upload handling."
},
"files": {
"type": {
"name": "object"
},
"required": true,
"description": "A map of files, indexed by file name (check file-shape on FileItem.js propTypes), that the user has uploaded.\nMust be maintained outside of `FileUpload`. It is up to the implementation to deny or accept file types, sizes, etc,\nand it is important that duplicates are not allowed."
},
"onFilesSelected": {
"type": {
"name": "func"
},
"required": true,
"description": "Will be called with `FileList`-object containing the `File`-objects the user selected.\nSee MDN for documentation on\n[FileList](https://developer.mozilla.org/en-US/docs/Web/API/FileList) and\n[File](https://developer.mozilla.org/en-US/docs/Web/API/File)."
},
"onFilesDropped": {
"type": {
"name": "func"
},
"required": true,
"description": "Will be called when objects are dropped over the upload-section."
},
"onFileDeleted": {
"type": {
"name": "func"
},
"required": true,
"description": "Called when the user clicks the delete button for a given file. Is called with the `File`\nobject of the file in question."
},
"multiple": {
"type": {
"name": "bool"
},
"required": false,
"description": "Whether or not uploading multiple files at once via the native file handler is allowed"
},
"title": {
"type": {
"name": "custom",
"raw": "stringType.isRequired"
},
"required": false,
"description": "Title module"
},
"infoText": {
"type": {
"name": "custom",
"raw": "stringType.isRequired"
},
"required": false,
"description": "Text on the info-section"
},
"infoSubText": {
"type": {
"name": "custom",
"raw": "stringType"
},
"required": false,
"description": "Subtext on the info-section"
},
"cancelText": {
"type": {
"name": "custom",
"raw": "stringType"
},
"required": false,
"description": "Label for the cancel button"
},
"deleteText": {
"type": {
"name": "custom",
"raw": "stringType"
},
"required": false,
"description": "Label for the delete button"
},
"uploadTitle": {
"type": {
"name": "custom",
"raw": "stringType.isRequired"
},
"required": false,
"description": "Title on the upload-section"
},
"uploadMicroText": {
"type": {
"name": "custom",
"raw": "stringType.isRequired"
},
"required": false,
"description": "MicroText on the upload-section"
},
"uploadSubText": {
"type": {
"name": "custom",
"raw": "stringType.isRequired"
},
"required": false,
"description": "SubText on the upload-section"
}
}
},
"packages/ffe-form-react/src/BaseFieldMessage.js": {
"description": "Internal factory component\n@ignore",
"displayName": "BaseFieldMessage",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"element": {
"type": {
"name": "string"
},
"required": false,
"description": "",
"defaultValue": {
"value": "'div'",
"computed": false
}
},
"type": {
"type": {
"name": "enum",
"value": [
{
"value": "'success'",
"computed": false
},
{
"value": "'info'",
"computed": false
},
{
"value": "'error'",
"computed": false
}
]
},
"required": true,
"description": ""
}
}
},
"packages/ffe-form-react/src/BaseRadioButton.js": {
"description": "",
"displayName": "BaseRadioButton",
"methods": [],
"props": {
"aria-invalid": {
"type": {
"name": "enum",
"value": [
{
"value": "'true'",
"computed": false
},
{
"value": "'false'",
"computed": false
}
]
},
"required": false,
"description": "Indicates whether the radio button is invalid or not"
},
"checked": {
"type": {
"name": "bool"
},
"required": false,
"description": "Whether or not the radio button is selected"
},
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "The label of the radio button"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Additional class names applied to the label"
},
"labelProps": {
"type": {
"name": "shape",
"value": {}
},
"required": false,
"description": "Additional props passed to the label element",
"defaultValue": {
"value": "{}",
"computed": false
}
},
"name": {
"type": {
"name": "string"
},
"required": true,
"description": "The name of the radio button"
},
"selectedValue": {
"type": {
"name": "union",
"value": [
{
"name": "bool"
},
{
"name": "string"
},
{
"name": "number"
}
]
},
"required": false,
"description": "The selected value of the radio button set"
},
"tooltip": {
"type": {
"name": "string"
},
"required": false,
"description": "Tooltip providing further detail about the choice"
},
"tooltipProps": {
"type": {
"name": "shape",
"value": {}
},
"required": false,
"description": "Additional props passed to the Tooltip component",
"defaultValue": {
"value": "{}",
"computed": false
}
},
"value": {
"type": {
"name": "union",
"value": [
{
"name": "bool"
},
{
"name": "string"
},
{
"name": "number"
}
]
},
"required": true,
"description": "The value of the radio button"
},
"innerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the input element"
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-form-react/src/Checkbox.js": {
"description": "",
"methods": [],
"props": {
"noMargins": {
"type": {
"name": "bool"
},
"required": false,
"description": "Removes vertical margins from the checkbox"
},
"hiddenLabel": {
"type": {
"name": "bool"
},
"required": false,
"description": "If you plan to render the checkbox without a visible label"
},
"id": {
"type": {
"name": "string"
},
"required": false,
"description": "Override the automatically generated ID"
},
"inline": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "true",
"computed": false
}
},
"children": {
"type": {
"name": "union",
"value": [
{
"name": "node"
},
{
"name": "func"
}
]
},
"required": false,
"description": "The label for the checkbox"
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-form-react/src/ErrorFieldMessage.js": {
"description": "",
"displayName": "ErrorFieldMessage",
"methods": []
},
"packages/ffe-form-react/src/InfoFieldMessage.js": {
"description": "",
"displayName": "InfoFieldMessage",
"methods": []
},
"packages/ffe-form-react/src/Input.js": {
"description": "",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"inline": {
"type": {
"name": "bool"
},
"required": false,
"description": "Input fields default to `display: block;`. Set this to `true` to apply the inline modifier."
},
"textLike": {
"type": {
"name": "bool"
},
"required": false,
"description": "Apply the text-like modifier by setting this to `true`."
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-form-react/src/InputGroup.js": {
"description": "",
"displayName": "InputGroup",
"methods": [],
"props": {
"inputId": {
"type": {
"name": "string"
},
"required": false,
"description": "The id that will be used on the input child if you don't want a generated one"
},
"labelId": {
"type": {
"name": "string"
},
"required": false,
"description": "The id used on the label in this component. Could be necessary if your component needs a aria-labelledby."
},
"children": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "node"
}
]
},
"required": true,
"description": "Unless you only have one element in your `InputGroup` you will have to use the function-as-a-child pattern."
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"extraMargin": {
"type": {
"name": "bool"
},
"required": false,
"description": "Reserve space for showing `fieldMessage`s so content below don't move\n vertically if an errormessage shows up. Note that this will only reserve\n space for one line of content, so keep messages short.",
"defaultValue": {
"value": "true",
"computed": false
}
},
"fieldMessage": {
"type": {
"name": "union",
"value": [
{
"name": "string"
},
{
"name": "node"
}
]
},
"required": false,
"description": "Use the ErrorFieldMessage component if you need more flexibility in how the content is rendered."
},
"description": {
"type": {
"name": "string"
},
"required": false,
"description": "To just render a static, always visible tooltip, use this."
},
"label": {
"type": {
"name": "union",
"value": [
{
"name": "node"
},
{
"name": "string"
}
]
},
"required": false,
"description": "Use the Label component if you need more flexibility in how the content is rendered."
},
"onTooltipToggle": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"tooltip": {
"type": {
"name": "union",
"value": [
{
"name": "bool"
},
{
"name": "node"
}
]
},
"required": false,
"description": "Use the Tooltip component if you need more flexibility in how the content is rendered."
}
}
},
"packages/ffe-form-react/src/Label.js": {
"description": "",
"displayName": "Label",
"methods": [],
"props": {
"block": {
"type": {
"name": "bool"
},
"required": false,
"description": "Labels default to `display: inline-block;` to have tooltips appear immediately to the right.\nSet this to `true` if you don't use tooltips and need the label to be `display: block;`."
},
"children": {
"type": {
"name": "node"
},
"required": true,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"htmlFor": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-form-react/src/PhoneNumber.js": {
"description": "",
"displayName": "PhoneNumber",
"methods": [],
"props": {
"number": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"countryCode": {
"type": {
"name": "string"
},
"required": false,
"description": "",
"defaultValue": {
"value": "'47'",
"computed": false
}
},
"onCountryCodeChange": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "() => {}",
"computed": false
}
},
"onNumberChange": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "() => {}",
"computed": false
}
},
"onCountryCodeBlur": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "() => {}",
"computed": false
}
},
"onNumberBlur": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "() => {}",
"computed": false
}
},
"locale": {
"type": {
"name": "string"
},
"required": false,
"description": "",
"defaultValue": {
"value": "'nb'",
"computed": false
}
},
"disabled": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"countryCodeInvalid": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"numberInvalid": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
},
"countryCodeRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the country code input element"
},
"numberRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the number input element"
}
}
},
"packages/ffe-form-react/src/RadioBlock.js": {
"description": "",
"displayName": "RadioBlock",
"methods": [],
"props": {
"checked": {
"type": {
"name": "bool"
},
"required": false,
"description": "Whether or not the radio block is selected"
},
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The content rendered when choice is selected"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Additional class names applied to the outer div"
},
"innerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the input element"
},
"label": {
"type": {
"name": "union",
"value": [
{
"name": "node"
},
{
"name": "string"
}
]
},
"required": true,
"description": "The always visible label of the radio block"
},
"labelClass": {
"type": {
"name": "string"
},
"required": false,
"description": "Additional class names applied to the label element"
},
"name": {
"type": {
"name": "string"
},
"required": true,
"description": "The name of the radio button set"
},
"selectedValue": {
"type": {
"name": "string"
},
"required": false,
"description": "The selected value of the radio button set"
},
"showChildren": {
"type": {
"name": "bool"
},
"required": false,
"description": "Whether or not children are always visible"
},
"value": {
"type": {
"name": "string"
},
"required": true,
"description": "The value of the radio block"
}
}
},
"packages/ffe-form-react/src/RadioButton.js": {
"description": "",
"displayName": "RadioButton",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Additional class names applied to the label"
},
"inline": {
"type": {
"name": "bool"
},
"required": false,
"description": "Indicates whether the radio button is rendered inline or as a block"
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-form-react/src/RadioButtonInputGroup.js": {
"description": "",
"displayName": "RadioButtonInputGroup",
"methods": [],
"props": {
"aria-invalid": {
"type": {
"name": "enum",
"value": [
{
"value": "'true'",
"computed": false
},
{
"value": "'false'",
"computed": false
}
]
},
"required": false,
"description": "Indicates whether the radio buttons inside this radio button group is\ninvalid or not. Propagated to all children."
},
"children": {
"type": {
"name": "func"
},
"required": true,
"description": "Function receiving props relevant to each radio button as an object\nargument. Expected to return a set of radio buttons, which should get\nthese properties applied to them."
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Additional class names applied to the fieldset"
},
"description": {
"type": {
"name": "string"
},
"required": false,
"description": "To just render a static, always visible tooltip, use this."
},
"extraMargin": {
"type": {
"name": "bool"
},
"required": false,
"description": "Reserve space for showing `fieldMessage`s so content below don't move\n vertically if an errormessage shows up. Note that this will only reserve\n space for one line of content, so keep messages short.",
"defaultValue": {
"value": "true",
"computed": false
}
},
"fieldMessage": {
"type": {
"name": "union",
"value": [
{
"name": "node"
},
{
"name": "string"
}
]
},
"required": false,
"description": "String or ErrorFieldMessage component with message"
},
"inline": {
"type": {
"name": "bool"
},
"required": false,
"description": "Indicates whether the radio buttons inside this radio button group is\nrendered inline or as a block."
},
"label": {
"type": {
"name": "union",
"value": [
{
"name": "node"
},
{
"name": "string"
}
]
},
"required": false,
"description": "The text describing the radio button set. Note that if you don't use this\nprop but provide your own label you should make sure your solution passes\nacessibility validation using a tool such as aXe DevTools."
},
"name": {
"type": {
"name": "string"
},
"required": false,
"description": "The name of the radio button"
},
"onChange": {
"type": {
"name": "func"
},
"required": false,
"description": "Change handler, receives value of selected radio button"
},
"selectedValue": {
"type": {
"name": "union",
"value": [
{
"name": "bool"
},
{
"name": "string"
},
{
"name": "number"
}
]
},
"required": false,
"description": "The currently selected value"
},
"tooltip": {
"type": {
"name": "union",
"value": [
{
"name": "node"
},
{
"name": "string"
}
]
},
"required": false,
"description": "String or Tooltip component with further detail about the radio button\nset"
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-form-react/src/RadioSwitch.js": {
"description": "",
"displayName": "RadioSwitch",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Additional class names applied to both radio buttons"
},
"leftLabel": {
"type": {
"name": "string"
},
"required": true,
"description": "The label of the choice to the left"
},
"leftValue": {
"type": {
"name": "union",
"value": [
{
"name": "bool"
},
{
"name": "string"
},
{
"name": "number"
}
]
},
"required": true,
"description": "The value of the choice to the left"
},
"leftInnerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the input element"
},
"rightLabel": {
"type": {
"name": "string"
},
"required": true,
"description": "The label of the choice to the right"
},
"rightValue": {
"type": {
"name": "union",
"value": [
{
"name": "bool"
},
{
"name": "string"
},
{
"name": "number"
}
]
},
"required": true,
"description": "The value of the choice to the right"
},
"rightInnerRef": {
"type": {
"name": "union",
"value": [
{
"name": "func"
},
{
"name": "shape",
"value": {
"current": {
"name": "object",
"required": false
}
}
}
]
},
"required": false,
"description": "Ref-setting function, or ref created by useRef, passed to the input element"
},
"selectedValue": {
"type": {
"name": "union",
"value": [
{
"name": "bool"
},
{
"name": "string"
},
{
"name": "number"
}
]
},
"required": false,
"description": "The selected value of the radio button set"
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": "Condensed modifier. Use in condensed designs"
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
},
"aria-invalid": {
"type": {
"name": "enum",
"value": [
{
"value": "'true'",
"computed": false
},
{
"value": "'false'",
"computed": false
}
]
},
"required": false,
"description": "Indicates whether the radio buttons inside this radio button group is\ninvalid or not. Propagated to all children."
}
}
},
"packages/ffe-form-react/src/SuccessFieldMessage.js": {
"description": "",
"displayName": "SuccessFieldMessage",
"methods": []
},
"packages/ffe-form-react/src/TextArea.js": {
"description": "",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-form-react/src/Tooltip.js": {
"description": "",
"displayName": "Tooltip",
"methods": [
{
"name": "onToggle",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "evt",
"type": null
}
],
"returns": null
}
],
"props": {
"aria-controls": {
"type": {
"name": "string"
},
"required": false,
"description": "Provide the id of the controlled element *unless* you're sending in children"
},
"aria-label": {
"type": {
"name": "string"
},
"required": false,
"description": "Descriptive text for the Tooltip expand icon",
"defaultValue": {
"value": "'Vis hjelpetekst'",
"computed": false
}
},
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The children are rendered in the expanded tooltip."
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "The className is set on the root node of the expanded tooltip."
},
"isOpen": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"onClick": {
"type": {
"name": "func"
},
"required": false,
"description": "Optional listener for clicks on the tooltip button. Is passed the event object."
},
"tabIndex": {
"type": {
"name": "number"
},
"required": false,
"description": "Sets the tabIndex of the tooltip button."
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-grid-react/src/Grid.js": {
"description": "",
"displayName": "Grid",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "Any children of a Grid must be a GridRow"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes are attached to the root node, in addition to ffe-grid classes"
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": "For a more compact grid"
},
"element": {
"type": {
"name": "string"
},
"required": false,
"description": "Specify the DOM element being used to create the Grid"
},
"topPadding": {
"type": {
"name": "bool"
},
"required": false,
"description": "Add top padding",
"defaultValue": {
"value": "true",
"computed": false
}
}
}
},
"packages/ffe-grid-react/src/GridCol.js": {
"description": "",
"displayName": "GridCol",
"methods": [],
"props": {
"background": {
"type": {
"name": "enum",
"value": [
{
"value": "'blue-ice'",
"computed": false
},
{
"value": "'blue-pale'",
"computed": false
},
{
"value": "'green-mint'",
"computed": false
},
{
"value": "'grey-cloud'",
"computed": false
},
{
"value": "'sand'",
"computed": false
},
{
"value": "'grey-warm'",
"computed": false
},
{
"value": "'orange-salmon'",
"computed": false
},
{
"value": "'red'",
"computed": false
},
{
"value": "'blue-sky'",
"computed": false
},
{
"value": "'white'",
"computed": false
}
]
},
"required": false,
"description": "Supported background colors"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes are attached to the root node, in addition to ffe-grid__col classes"
},
"element": {
"type": {
"name": "node"
},
"required": false,
"description": "Specify the DOM element being used to create the GridCol",
"defaultValue": {
"value": "'div'",
"computed": false
}
},
"around": {
"type": {
"name": "bool"
},
"required": false,
"description": "Distribute remaining space around the content elements"
},
"between": {
"type": {
"name": "bool"
},
"required": false,
"description": "Distribute remaining space between the content elements"
},
"bottom": {
"type": {
"name": "bool"
},
"required": false,
"description": "Place content elements at the bottom of the column"
},
"center": {
"type": {
"name": "bool"
},
"required": false,
"description": "Center content horizontally"
},
"centerText": {
"type": {
"name": "bool"
},
"required": false,
"description": "Center text content horizontally"
},
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The content of the column"
},
"end": {
"type": {
"name": "bool"
},
"required": false,
"description": "Place content elements to the right of the column"
},
"horizontal": {
"type": {
"name": "bool"
},
"required": false,
"description": "Layout column content horizontally and flip flex direction"
},
"middle": {
"type": {
"name": "bool"
},
"required": false,
"description": "Center content vertically"
},
"bottomPadding": {
"type": {
"name": "bool"
},
"required": false,
"description": "Add bottom padding",
"defaultValue": {
"value": "true",
"computed": false
}
},
"reverse": {
"type": {
"name": "bool"
},
"required": false,
"description": "Reverse layout direction"
},
"start": {
"type": {
"name": "bool"
},
"required": false,
"description": "Place content elements to the left of the column"
},
"top": {
"type": {
"name": "bool"
},
"required": false,
"description": "Place content elements at the top of the column"
},
"sm": {
"type": {
"name": "union",
"value": [
{
"name": "number",
"description": "Number of columns, 0-12"
},
{
"name": "string",
"description": "Number of columns, 0-12"
},
{
"name": "shape",
"value": {
"cols": {
"name": "union",
"value": [
{
"name": "number"
},
{
"name": "string"
}
],
"description": "Number of columns, 0-12",
"required": false
},
"offset": {
"name": "union",
"value": [
{
"name": "number"
},
{
"name": "string"
}
],
"description": "Number of colums offset, 0-12",
"required": false
}
}
}
]
},
"required": false,
"description": "Size modifiers for small screen sizes"
},
"md": {
"type": {
"name": "union",
"value": [
{
"name": "number",
"description": "Number of columns, 0-12"
},
{
"name": "string",
"description": "Number of columns, 0-12"
},
{
"name": "shape",
"value": {
"cols": {
"name": "union",
"value": [
{
"name": "number"
},
{
"name": "string"
}
],
"description": "Number of columns, 0-12",
"required": false
},
"offset": {
"name": "union",
"value": [
{
"name": "number"
},
{
"name": "string"
}
],
"description": "Number of colums offset, 0-12",
"required": false
}
}
}
]
},
"required": false,
"description": "Size modifiers for medium screen sizes"
},
"lg": {
"type": {
"name": "union",
"value": [
{
"name": "number",
"description": "Number of columns, 0-12"
},
{
"name": "string",
"description": "Number of columns, 0-12"
},
{
"name": "shape",
"value": {
"cols": {
"name": "union",
"value": [
{
"name": "number"
},
{
"name": "string"
}
],
"description": "Number of columns, 0-12",
"required": false
},
"offset": {
"name": "union",
"value": [
{
"name": "number"
},
{
"name": "string"
}
],
"description": "Number of colums offset, 0-12",
"required": false
}
}
}
]
},
"required": false,
"description": "Size modifiers for large screen sizes"
}
}
},
"packages/ffe-grid-react/src/GridRow.js": {
"description": "",
"displayName": "GridRow",
"methods": [],
"props": {
"background": {
"type": {
"name": "enum",
"value": [
{
"value": "'blue-ice'",
"computed": false
},
{
"value": "'blue-pale'",
"computed": false
},
{
"value": "'green-mint'",
"computed": false
},
{
"value": "'grey-cloud'",
"computed": false
},
{
"value": "'sand'",
"computed": false
},
{
"value": "'grey-warm'",
"computed": false
},
{
"value": "'orange-salmon'",
"computed": false
},
{
"value": "'red'",
"computed": false
},
{
"value": "'blue-sky'",
"computed": false
},
{
"value": "'white'",
"computed": false
}
]
},
"required": false,
"description": "Supported background colors"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes are attached to the root node, in addition to ffe-grid__row classes"
},
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "All children of a `<GridRow />` must be `<GridCol />`."
},
"element": {
"type": {
"name": "string"
},
"required": false,
"description": "Specify the DOM element being used to create the GridRow"
},
"reverse": {
"type": {
"name": "bool"
},
"required": false,
"description": "If true, columns are reversed"
},
"topPadding": {
"type": {
"name": "bool"
},
"required": false,
"description": "If true, row receives top padding. Useful for when you have background colored rows",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-grid-react/src/InlineGrid.js": {
"description": "",
"displayName": "InlineGrid",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "Any children of a InlineGrid must be a GridRow"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes are attached to the root node, in addition to ffe-grid classes"
},
"element": {
"type": {
"name": "string"
},
"required": false,
"description": "Specify the DOM element being used to create the Grid",
"defaultValue": {
"value": "'div'",
"computed": false
}
}
}
},
"packages/ffe-lists-react/src/BulletList.js": {
"description": "",
"displayName": "BulletList",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "List items"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes"
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": "Condensed modifier. Use in condensed designs"
}
}
},
"packages/ffe-lists-react/src/BulletListItem.js": {
"description": "",
"displayName": "BulletListItem",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes"
}
}
},
"packages/ffe-lists-react/src/CheckList.js": {
"description": "",
"displayName": "CheckList",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "List items"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes"
},
"columns": {
"type": {
"name": "enum",
"value": [
{
"value": "1",
"computed": false
},
{
"value": "2",
"computed": false
},
{
"value": "'1'",
"computed": false
},
{
"value": "'2'",
"computed": false
}
]
},
"required": false,
"description": "",
"defaultValue": {
"value": "1",
"computed": false
}
}
}
},
"packages/ffe-lists-react/src/CheckListItem.js": {
"description": "",
"displayName": "CheckListItem",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes"
},
"isCross": {
"type": {
"name": "bool"
},
"required": false,
"description": "If true, render a red cross instead of a green checkmark",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-lists-react/src/DescriptionList.js": {
"description": "",
"displayName": "DescriptionList",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "List items"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes"
},
"medium": {
"type": {
"name": "bool"
},
"required": false,
"description": "Medium list. Can't be used with `large` prop"
},
"large": {
"type": {
"name": "bool"
},
"required": false,
"description": "Large list. Can't be used with `medium` prop"
},
"horizontal": {
"type": {
"name": "bool"
},
"required": false,
"description": "Displays dts and dds inline"
}
}
},
"packages/ffe-lists-react/src/DescriptionListDescription.js": {
"description": "",
"displayName": "DescriptionListDescription",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes"
}
}
},
"packages/ffe-lists-react/src/DescriptionListMultiCol.js": {
"description": "",
"displayName": "DescriptionListMultiCol",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "List items"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes"
}
}
},
"packages/ffe-lists-react/src/DescriptionListTerm.js": {
"description": "",
"displayName": "DescriptionListTerm",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes"
}
}
},
"packages/ffe-lists-react/src/NumberedList.js": {
"description": "",
"displayName": "NumberedList",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "List items"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes"
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": "Condensed modifier. Use in condensed designs"
}
}
},
"packages/ffe-lists-react/src/NumberedListItem.js": {
"description": "",
"displayName": "NumberedListItem",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes"
}
}
},
"packages/ffe-lists-react/src/StylizedNumberedList.js": {
"description": "",
"displayName": "StylizedNumberedList",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "List items"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes"
}
}
},
"packages/ffe-lists-react/src/StylizedNumberedListItem.js": {
"description": "",
"displayName": "StylizedNumberedListItem",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra classes"
}
}
},
"packages/ffe-message-box-react/src/BaseMessage.js": {
"description": "",
"displayName": "BaseMessage",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"content": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"icon": {
"type": {
"name": "node"
},
"required": true,
"description": ""
},
"title": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"type": {
"type": {
"name": "enum",
"value": [
{
"value": "'success'",
"computed": false
},
{
"value": "'error'",
"computed": false
},
{
"value": "'tips'",
"computed": false
},
{
"value": "'info'",
"computed": false
}
]
},
"required": true,
"description": "Internal type enum for specifying the style of message box. Should not be used directly\n@ignore"
}
}
},
"packages/ffe-message-box-react/src/ErrorMessage.js": {
"description": "",
"displayName": "ErrorMessage",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The content of the message box"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra class names to the wrapping DOM node"
},
"content": {
"type": {
"name": "node"
},
"required": false,
"description": "Deprecated. Use `children` instead.\n@deprecated"
},
"icon": {
"type": {
"name": "node"
},
"required": false,
"description": "The icon to show. Has a default value, but can be overridden"
},
"title": {
"type": {
"name": "node"
},
"required": false,
"description": "An optional title for the message"
},
"alert": {
"type": {
"name": "bool"
},
"required": false,
"description": "When false, role is not set to alert, avoids message from being read up immediately after page load. Default value is true.",
"defaultValue": {
"value": "true",
"computed": false
}
}
}
},
"packages/ffe-message-box-react/src/InfoMessage.js": {
"description": "",
"displayName": "InfoMessage",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The content of the message box"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra class names to the wrapping DOM node"
},
"content": {
"type": {
"name": "node"
},
"required": false,
"description": "Deprecated. Use `children` instead.\n@deprecated"
},
"icon": {
"type": {
"name": "node"
},
"required": false,
"description": "The icon to show. Has a default value, but can be overridden"
},
"title": {
"type": {
"name": "node"
},
"required": false,
"description": "An optional title for the message"
}
}
},
"packages/ffe-message-box-react/src/SuccessMessage.js": {
"description": "",
"displayName": "SuccessMessage",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The content of the message box"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra class names to the wrapping DOM node"
},
"content": {
"type": {
"name": "node"
},
"required": false,
"description": "Deprecated. Use `children` instead.\n@deprecated"
},
"icon": {
"type": {
"name": "node"
},
"required": false,
"description": "The icon to show. Has a default value, but can be overridden"
},
"title": {
"type": {
"name": "node"
},
"required": false,
"description": "An optional title for the message"
}
}
},
"packages/ffe-message-box-react/src/TipsMessage.js": {
"description": "",
"displayName": "TipsMessage",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": "The content of the message box"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Any extra class names to the wrapping DOM node"
},
"content": {
"type": {
"name": "node"
},
"required": false,
"description": "Deprecated. Use `children` instead.\n@deprecated"
},
"icon": {
"type": {
"name": "node"
},
"required": false,
"description": "The icon to show. Has a default value, but can be overridden"
},
"title": {
"type": {
"name": "node"
},
"required": false,
"description": "An optional title for the message"
}
}
},
"packages/ffe-searchable-dropdown-react/src/ListItemBody.js": {
"description": "",
"displayName": "ListItemBody",
"methods": [],
"props": {
"item": {
"type": {
"name": "object"
},
"required": true,
"description": ""
},
"dropdownAttributes": {
"type": {
"name": "arrayOf",
"value": {
"name": "string"
}
},
"required": true,
"description": ""
},
"isHighlighted": {
"type": {
"name": "bool"
},
"required": true,
"description": ""
}
}
},
"packages/ffe-searchable-dropdown-react/src/ListItemContainer.js": {
"description": "",
"displayName": "ListItemContainer",
"methods": [],
"props": {
"getItemProps": {
"type": {
"name": "func"
},
"required": true,
"description": ""
},
"item": {
"type": {
"name": "object"
},
"required": true,
"description": ""
},
"isHighlighted": {
"type": {
"name": "bool"
},
"required": true,
"description": ""
},
"dropdownAttributes": {
"type": {
"name": "arrayOf",
"value": {
"name": "string"
}
},
"required": true,
"description": ""
},
"children": {
"type": {
"name": "func"
},
"required": true,
"description": ""
}
}
},
"packages/ffe-searchable-dropdown-react/src/SearchableDropdown.js": {
"description": "",
"displayName": "SearchableDropdown",
"methods": [],
"props": {
"id": {
"type": {
"name": "string"
},
"required": true,
"description": "Id of drop down"
},
"labelId": {
"type": {
"name": "string"
},
"required": true,
"description": "Id of label"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Extra class"
},
"dropdownList": {
"type": {
"name": "arrayOf",
"value": {
"name": "object"
}
},
"required": true,
"description": "List of objects to be displayed in dropdown"
},
"dropdownAttributes": {
"type": {
"name": "arrayOf",
"value": {
"name": "string"
}
},
"required": true,
"description": "Array of attributes to be displayed in list"
},
"searchAttributes": {
"type": {
"name": "arrayOf",
"value": {
"name": "string"
}
},
"required": true,
"description": "Array of attributes used when filtering search"
},
"inputProps": {
"type": {
"name": "shape",
"value": {
"onFocus": {
"name": "func",
"required": false
}
}
},
"required": false,
"description": "Props used on input field",
"defaultValue": {
"value": "{}",
"computed": false
}
},
"initialValue": {
"type": {
"name": "object"
},
"required": false,
"description": "One of the elements from dropdownList to be used as default value"
},
"maxRenderedDropdownElements": {
"type": {
"name": "number"
},
"required": false,
"description": "Limits number of rendered dropdown elements",
"defaultValue": {
"value": "Number.MAX_SAFE_INTEGER",
"computed": true
}
},
"onChange": {
"type": {
"name": "func"
},
"required": false,
"description": "Called when a value is selected",
"defaultValue": {
"value": "Function.prototype",
"computed": true
}
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant"
},
"listElementBody": {
"type": {
"name": "func"
},
"required": false,
"description": "Custom element to use for each item in dropDownList"
},
"noMatch": {
"type": {
"name": "shape",
"value": {
"text": {
"name": "string",
"required": true
},
"dropdownList": {
"name": "arrayOf",
"value": {
"name": "object"
},
"required": false
}
}
},
"required": false,
"description": "Message and a dropdownList to use when no match",
"defaultValue": {
"value": "{}",
"computed": false
}
},
"locale": {
"type": {
"name": "enum",
"computed": true,
"value": "Object.values(locales)"
},
"required": false,
"description": "Locale to use for translations"
},
"aria-invalid": {
"type": {
"name": "union",
"value": [
{
"name": "string"
},
{
"name": "bool"
}
]
},
"required": false,
"description": "aria-invalid attribute"
}
}
},
"packages/ffe-spinner-react/src/Spinner.js": {
"description": "",
"displayName": "Spinner",
"methods": [],
"props": {
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"large": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
},
"packages/ffe-system-message-react/src/SystemErrorMessage.js": {
"description": "",
"displayName": "SystemErrorMessage",
"methods": [],
"props": {
"animationLengthMs": {
"type": {
"name": "number"
},
"required": false,
"description": "",
"defaultValue": {
"value": "300",
"computed": false
}
},
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "The content of the system message"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Additional classes added to the surrounding div"
},
"icon": {
"type": {
"name": "node"
},
"required": true,
"description": "Override the default icon - use with caution!"
},
"locale": {
"type": {
"name": "enum",
"value": [
{
"value": "'en'",
"computed": false
},
{
"value": "'nb'",
"computed": false
},
{
"value": "'nn'",
"computed": false
}
]
},
"required": false,
"description": "'nb', 'nn', or 'en'",
"defaultValue": {
"value": "'nb'",
"computed": false
}
},
"modifier": {
"type": {
"name": "enum",
"value": [
{
"value": "'error'",
"computed": false
},
{
"value": "'info'",
"computed": false
},
{
"value": "'success'",
"computed": false
},
{
"value": "'news'",
"computed": false
}
]
},
"required": false,
"description": "The type of system message. Used internally only-\n@ignore"
},
"onClose": {
"type": {
"name": "func"
},
"required": false,
"description": "Callback for when the system message has been closed (after animation ends)",
"defaultValue": {
"value": "f => f",
"computed": false
}
},
"alert": {
"type": {
"name": "bool"
},
"required": false,
"description": "When false, role is not set to alert, avoids message from being read up immediately after page load. Default value is true.",
"defaultValue": {
"value": "true",
"computed": false
}
}
}
},
"packages/ffe-system-message-react/src/SystemInfoMessage.js": {
"description": "",
"displayName": "SystemInfoMessage",
"methods": []
},
"packages/ffe-system-message-react/src/SystemMessage.js": {
"description": "",
"displayName": "SystemMessage",
"methods": [
{
"name": "close",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "event",
"type": null
}
],
"returns": null
}
],
"props": {
"animationLengthMs": {
"type": {
"name": "number"
},
"required": false,
"description": "",
"defaultValue": {
"value": "300",
"computed": false
}
},
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "The content of the system message"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Additional classes added to the surrounding div"
},
"icon": {
"type": {
"name": "node"
},
"required": true,
"description": "Override the default icon - use with caution!"
},
"locale": {
"type": {
"name": "enum",
"value": [
{
"value": "'en'",
"computed": false
},
{
"value": "'nb'",
"computed": false
},
{
"value": "'nn'",
"computed": false
}
]
},
"required": false,
"description": "'nb', 'nn', or 'en'",
"defaultValue": {
"value": "'nb'",
"computed": false
}
},
"modifier": {
"type": {
"name": "enum",
"value": [
{
"value": "'error'",
"computed": false
},
{
"value": "'info'",
"computed": false
},
{
"value": "'success'",
"computed": false
},
{
"value": "'news'",
"computed": false
}
]
},
"required": false,
"description": "The type of system message. Used internally only-\n@ignore"
},
"onClose": {
"type": {
"name": "func"
},
"required": false,
"description": "Callback for when the system message has been closed (after animation ends)",
"defaultValue": {
"value": "f => f",
"computed": false
}
}
}
},
"packages/ffe-system-message-react/src/SystemNewsMessage.js": {
"description": "",
"displayName": "SystemNewsMessage",
"methods": []
},
"packages/ffe-system-message-react/src/SystemSuccessMessage.js": {
"description": "",
"displayName": "SystemSuccessMessage",
"methods": []
},
"packages/ffe-tables-react/src/SortableTable/SortableTable.js": {
"description": "",
"displayName": "SortableTable",
"methods": [
{
"name": "sortStateHasChanged",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "nextState",
"type": null
}
],
"returns": null
},
{
"name": "tableHeaderClicked",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "columnKey",
"type": null
}
],
"returns": null
},
{
"name": "handleKeyPress",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "columnKey",
"type": null
},
{
"name": "event",
"type": null
}
],
"returns": null
},
{
"name": "getAriaSort",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "column",
"type": null
}
],
"returns": null
},
{
"name": "decorateSortableTableHeader",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "column",
"type": null
}
],
"returns": null
}
],
"props": {
"caption": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"srOnlyCaption": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"expandedContentMapper": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"offset": {
"type": {
"name": "number"
},
"required": false,
"description": ""
},
"limit": {
"type": {
"name": "number"
},
"required": false,
"description": ""
},
"columnLayoutMobile": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"smallHeader": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"alignLeft": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"breakpoint": {
"type": {
"name": "enum",
"value": [
{
"value": "'sm'",
"computed": false
},
{
"value": "'none'",
"computed": false
}
]
},
"required": false,
"description": ""
},
"columns": {
"type": {
"name": "arrayOf",
"value": {
"name": "object"
}
},
"required": true,
"description": ""
},
"data": {
"type": {
"name": "arrayOf",
"value": {
"name": "object"
}
},
"required": true,
"description": ""
},
"sortBy": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"descending": {
"type": {
"name": "bool"
},
"required": false,
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
"onSort": {
"type": {
"name": "func"
},
"required": false,
"description": "",
"defaultValue": {
"value": "() => {}",
"computed": false
}
},
"rowRender": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"headerRender": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"footerRender": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-tables-react/src/Table/Table.js": {
"description": "",
"displayName": "Table",
"methods": [
{
"name": "renderTableCaption",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "renderTableHeaders",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "renderTableFooter",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "getData",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "renderTableBody",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
}
],
"props": {
"alignLeft": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"columnLayoutMobile": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"caption": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"srOnlyCaption": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"expandedContentMapper": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"smallHeader": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"sort": {
"type": {
"name": "object"
},
"required": false,
"description": ""
},
"offset": {
"type": {
"name": "number"
},
"required": false,
"description": "",
"defaultValue": {
"value": "0",
"computed": false
}
},
"limit": {
"type": {
"name": "number"
},
"required": false,
"description": "",
"defaultValue": {
"value": "0",
"computed": false
}
},
"breakpoint": {
"type": {
"name": "enum",
"value": [
{
"value": "'sm'",
"computed": false
},
{
"value": "'none'",
"computed": false
}
]
},
"required": false,
"description": ""
},
"data": {
"type": {
"name": "arrayOf",
"value": {
"name": "object"
}
},
"required": false,
"description": "",
"defaultValue": {
"value": "[]",
"computed": false
}
},
"columns": {
"type": {
"name": "arrayOf",
"value": {
"name": "shape",
"value": {
"header": {
"name": "node",
"required": true
},
"key": {
"name": "string",
"required": true
}
}
}
},
"required": false,
"description": "",
"defaultValue": {
"value": "[]",
"computed": false
}
},
"rowRender": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"headerRender": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"footerRender": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-tables-react/src/Table.js": {
"description": "",
"displayName": "Table",
"methods": [],
"props": {
"caption": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"srOnlyCaption": {
"type": {
"name": "bool"
},
"required": false,
"description": "Make the caption only visible for screen readers"
},
"expandedContentMapper": {
"type": {
"name": "func"
},
"required": false,
"description": "A mapping function that returns a renderable node that will be rendered for each expandable row"
},
"sortable": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"sortBy": {
"type": {
"name": "string"
},
"required": false,
"description": "A string reference to a column key to set an initial sort of the table"
},
"descending": {
"type": {
"name": "bool"
},
"required": false,
"description": "Used in conjunction with sortBy"
},
"offset": {
"type": {
"name": "number"
},
"required": false,
"description": "When paginated, lets you set the number of rows to offset from the beginning"
},
"limit": {
"type": {
"name": "number"
},
"required": false,
"description": "Limits the number of rows to show on one page. Decides whether or not to paginate your table"
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": "Makes your table condensed - for pages that show a lot of data"
},
"smallHeader": {
"type": {
"name": "bool"
},
"required": false,
"description": "Set to true if you want the row headings to be narrower on smalls screens"
},
"alignLeft": {
"type": {
"name": "bool"
},
"required": false,
"description": "Removes left cell padding from the first column"
},
"columnLayoutMobile": {
"type": {
"name": "bool"
},
"required": false,
"description": "Show your table as a regular column based table on small devices"
},
"breakpoint": {
"type": {
"name": "enum",
"value": [
{
"value": "'sm'",
"computed": false
},
{
"value": "'none'",
"computed": false
}
]
},
"required": false,
"description": "Decide if your table rows should break into a vertical view on small or no devices"
},
"rowRender": {
"type": {
"name": "func"
},
"required": false,
"description": "Override rendering of rows with a prop\nrowRender={(props, rowcontent, trprops, index)=>{return <tr {...trprops}>{rowcontent}</tr>}}"
},
"headerRender": {
"type": {
"name": "func"
},
"required": false,
"description": "Override rendering of headers with a prop\nheaderRender={(props, rowcontent, trprops) => {return <tr {...trprops}>{rowcontent}</tr>}}"
},
"footerRender": {
"type": {
"name": "func"
},
"required": false,
"description": "Override rendering of footer with a prop\nfooterRender={(props, rowcontent, trprops) => {return <tr {...trprops}>{rowcontent}</tr>}}"
},
"data": {
"type": {
"name": "arrayOf",
"value": {
"name": "shape",
"value": {
"id": {
"name": "union",
"value": [
{
"name": "string"
},
{
"name": "number"
}
],
"description": "A unique ID for each row of data. Required for sorting",
"required": false
}
}
}
},
"required": false,
"description": "An array of objects with keys equal to the columns array's key value, and value equal to whatever you\nwant in your cell. These are basically an array of rows"
},
"columns": {
"type": {
"name": "arrayOf",
"value": {
"name": "shape",
"value": {
"header": {
"name": "node",
"description": "The column header. Required, but may be an empty string.",
"required": true
},
"key": {
"name": "string",
"description": "The column key used in the `data` array's objects",
"required": true
},
"footer": {
"name": "node",
"description": "Content shown in the table footer",
"required": false
},
"alignRight": {
"name": "bool",
"required": false
},
"alignTop": {
"name": "bool",
"required": false
},
"hideOnDesktop": {
"name": "bool",
"required": false
},
"hideOnTablet": {
"name": "bool",
"required": false
},
"hideOnSmallTablet": {
"name": "bool",
"required": false
},
"hideOnMobile": {
"name": "bool",
"required": false
},
"compare": {
"name": "func",
"description": "Custom comparator function for sorting this column",
"required": false
},
"notSortable": {
"name": "bool",
"description": "Disable column from sorting. Not needed if heading is an empty string",
"required": false
},
"cellRender": {
"name": "func",
"required": false
},
"columnHeaderRender": {
"name": "func",
"required": false
},
"columnFooterRender": {
"name": "func",
"required": false
}
}
}
},
"required": false,
"description": "An array of objects with a key describing your column, and a header describing that column"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Class names set in addition to the ffe tables classes."
}
}
},
"packages/ffe-tables-react/src/TableParts/TableCell.js": {
"description": "",
"displayName": "TableCell",
"methods": [],
"props": {
"alignRight": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"alignTop": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"children": {
"type": {
"name": "any"
},
"required": false,
"description": ""
},
"columnHeader": {
"type": {
"name": "union",
"value": [
{
"name": "string"
},
{
"name": "node"
}
]
},
"required": false,
"description": ""
},
"contentClasses": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"tdClasses": {
"type": {
"name": "string"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-tables-react/src/TableParts/TableFooter.js": {
"description": "",
"displayName": "TableFooter",
"methods": [],
"props": {
"columns": {
"type": {
"name": "arrayOf",
"value": {
"name": "shape",
"value": {
"alignRight": {
"name": "bool",
"required": false
},
"alignTop": {
"name": "bool",
"required": false
},
"footer": {
"name": "any",
"required": false
},
"header": {
"name": "node",
"required": true
},
"hideOnDesktop": {
"name": "bool",
"required": false
},
"hideOnMobile": {
"name": "bool",
"required": false
},
"hideOnSmallTablet": {
"name": "bool",
"required": false
},
"hideOnTablet": {
"name": "bool",
"required": false
}
}
}
},
"required": false,
"description": ""
},
"footerRender": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"dataWindow": {
"type": {
"name": "array"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-tables-react/src/TableParts/TableHeaders.js": {
"description": "",
"displayName": "TableHeaders",
"methods": [],
"props": {
"columns": {
"type": {
"name": "arrayOf",
"value": {
"name": "shape",
"value": {
"alignRight": {
"name": "bool",
"required": false
},
"header": {
"name": "node",
"required": true
},
"hideOnDesktop": {
"name": "bool",
"required": false
},
"hideOnMobile": {
"name": "bool",
"required": false
},
"hideOnSmallTablet": {
"name": "bool",
"required": false
},
"hideOnTablet": {
"name": "bool",
"required": false
},
"key": {
"name": "string",
"required": true
}
}
}
},
"required": false,
"description": ""
},
"headerRender": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"dataWindow": {
"type": {
"name": "array"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-tables-react/src/TableParts/TableRow.js": {
"description": "",
"displayName": "TableRow",
"methods": [],
"props": {
"cells": {
"type": {
"name": "object"
},
"required": true,
"description": ""
},
"columns": {
"type": {
"name": "arrayOf",
"value": {
"name": "shape",
"value": {
"alignRight": {
"name": "bool",
"required": false
},
"alignTop": {
"name": "bool",
"required": false
},
"header": {
"name": "any",
"required": false
},
"hideOnDesktop": {
"name": "bool",
"required": false
},
"hideOnMobile": {
"name": "bool",
"required": false
},
"hideOnSmallTablet": {
"name": "bool",
"required": false
},
"hideOnTablet": {
"name": "bool",
"required": false
},
"key": {
"name": "string",
"required": false
},
"cellRender": {
"name": "func",
"required": false
}
}
}
},
"required": true,
"description": ""
},
"expandable": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"expanded": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"onClick": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"rowRender": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"headerRender": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"footerRender": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"onKeyDown": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"trClasses": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"rowIndex": {
"type": {
"name": "number"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-tables-react/src/TableParts/TableRowExpandable.js": {
"description": "",
"displayName": "TableRowExpandable",
"methods": [
{
"name": "getDerivedStateFromProps",
"docblock": null,
"modifiers": [
"static"
],
"params": [
{
"name": "nextProps",
"type": null
},
{
"name": "prevState",
"type": null
}
],
"returns": null
},
{
"name": "toggleExpand",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
},
{
"name": "handleKeyPress",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "event",
"type": null
}
],
"returns": null
}
],
"props": {
"children": {
"type": {
"name": "node"
},
"required": false,
"description": ""
},
"cells": {
"type": {
"name": "object"
},
"required": true,
"description": ""
},
"columns": {
"type": {
"name": "array"
},
"required": true,
"description": ""
},
"sort": {
"type": {
"name": "object"
},
"required": false,
"description": ""
},
"rowRender": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"headerRender": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"footerRender": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
"rowIndex": {
"type": {
"name": "number"
},
"required": false,
"description": ""
},
"defaultExpanded": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
},
"scrollToOnMount": {
"type": {
"name": "bool"
},
"required": false,
"description": ""
}
}
},
"packages/ffe-tabs-react/src/Tab.js": {
"description": "",
"displayName": "Tab",
"methods": [],
"props": {
"selected": {
"type": {
"name": "bool"
},
"required": false,
"description": "Selected tab button"
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": "Compact style tab button"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Additional css classes"
},
"aria-controls": {
"type": {
"name": "string"
},
"required": true,
"description": "Id of the element it controls"
}
}
},
"packages/ffe-tabs-react/src/TabButton.js": {
"description": "",
"displayName": "TabButton",
"methods": [],
"props": {
"selected": {
"type": {
"name": "bool"
},
"required": false,
"description": "Selected tab button"
},
"ghost": {
"type": {
"name": "bool"
},
"required": false,
"description": "Transparent background style tab button"
},
"condensed": {
"type": {
"name": "bool"
},
"required": false,
"description": "Compact style tab button"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Additional css classes"
},
"dark": {
"type": {
"name": "bool"
},
"required": false,
"description": "Dark variant",
"defaultValue": {
"value": "false",
"computed": false
}
},
"aria-controls": {
"type": {
"name": "string"
},
"required": true,
"description": "Id of the element it controls"
}
}
},
"packages/ffe-tabs-react/src/TabButtonGroup.js": {
"description": "",
"displayName": "TabButtonGroup",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "TabGroup contents - a group of Tabs"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Additional css classes"
},
"thin": {
"type": {
"name": "bool"
},
"required": false,
"description": "Applies the thin modifier to remove margins"
}
}
},
"packages/ffe-tabs-react/src/TabGroup.js": {
"description": "",
"displayName": "TabGroup",
"methods": [],
"props": {
"children": {
"type": {
"name": "node"
},
"required": true,
"description": "TabGroup contents - a group of Tabs"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "Additional css classes"
},
"thin": {
"type": {
"name": "bool"
},
"required": false,
"description": "Applies the thin modifier to remove margins"
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment