@it-corp/vpbank-spotlight/docs/src/.docgen/docgen.json

Command center components for react and VPbank components

{
  "@it-corp/vpbank-spotlight/Spotlight": {
    "props": {
      "actions": {
        "description": "Actions data, passed down to <code>Spotlight.Action</code> component",
        "name": "actions",
        "required": true,
        "type": {
          "name": "SpotlightActions[]"
        }
      },
      "clearQueryOnClose": {
        "description": "Determines whether the search query should be cleared when the spotlight is closed, <code>true</code> by default",
        "name": "clearQueryOnClose",
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "closeOnActionTrigger": {
        "description": "Determines whether spotlight should be closed when one of the actions is triggered, <code>true</code> by default",
        "name": "closeOnActionTrigger",
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "disabled": {
        "description": "If set, spotlight will not be rendered",
        "name": "disabled",
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "filter": {
        "description": "Function to filter actions data based on search query, by default actions are filtered by title, description and keywords",
        "name": "filter",
        "required": false,
        "type": {
          "name": "SpotlightFilterFunction"
        }
      },
      "forceOpened": {
        "description": "Forces opened state, useful for tests",
        "name": "forceOpened",
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "highlightQuery": {
        "description": "Determines whether search query should be highlighted in action label, <code>false</code> by default",
        "name": "highlightQuery",
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "limit": {
        "description": "Maximum number of actions displayed at a time, <code>Infinity</code> by default",
        "name": "limit",
        "required": false,
        "type": {
          "name": "number"
        }
      },
      "maxHeight": {
        "description": "Spotlight content max-height. Ignored unless <code>scrollable</code> prop is set. <code>400</code> by default",
        "name": "maxHeight",
        "required": false,
        "type": {
          "name": "MaxHeight<string | number>"
        }
      },
      "nothingFound": {
        "description": "Message displayed when none of the actions match given <code>filter</code>",
        "name": "nothingFound",
        "required": false,
        "type": {
          "name": "React.ReactNode"
        }
      },
      "onQueryChange": {
        "description": "Called when query changes",
        "name": "onQueryChange",
        "required": false,
        "type": {
          "name": "((query: string) => void)"
        }
      },
      "onSpotlightClose": {
        "description": "Called when spotlight closes",
        "name": "onSpotlightClose",
        "required": false,
        "type": {
          "name": "(() => void)"
        }
      },
      "onSpotlightOpen": {
        "description": "Called when spotlight opens",
        "name": "onSpotlightOpen",
        "required": false,
        "type": {
          "name": "(() => void)"
        }
      },
      "query": {
        "description": "Controlled Spotlight search query",
        "name": "query",
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "scrollable": {
        "description": "Determines whether the actions list should be scrollable. If not set, <code>maxHeight</code> is ignored, <code>false</code> by default",
        "name": "scrollable",
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "searchProps": {
        "description": "Props passed down to the <code>Spotlight.Search</code>",
        "name": "searchProps",
        "required": false,
        "type": {
          "name": "SpotlightSearchProps"
        }
      },
      "shortcut": {
        "description": "Keyboard shortcut or a list of shortcuts to trigger spotlight, <code>'mod + K'</code> by default",
        "name": "shortcut",
        "required": false,
        "type": {
          "name": "string | string[] | null"
        }
      },
      "store": {
        "description": "Spotlight store, can be used to create multiple instances of spotlight",
        "name": "store",
        "required": false,
        "type": {
          "name": "SpotlightStore"
        }
      },
      "tagsToIgnore": {
        "description": "A list of tags which when focused will be ignored by shortcut, <code>['input', 'textarea', 'select']</code> by default",
        "name": "tagsToIgnore",
        "required": false,
        "type": {
          "name": "string[]"
        }
      },
      "triggerOnContentEditable": {
        "description": "Determines whether shortcut should trigger based in contentEditable, <code>false</code> by default",
        "name": "triggerOnContentEditable",
        "required": false,
        "type": {
          "name": "boolean"
        }
      }
    }
  },
  "@it-corp/vpbank-spotlight/SpotlightAction": {
    "props": {
      "children": {
        "description": "Children override default action elements, if passed, label, description and sections are hidden",
        "name": "children",
        "required": false,
        "type": {
          "name": "React.ReactNode"
        }
      },
      "closeSpotlightOnTrigger": {
        "description": "Determines whether the spotlight should be closed when action is triggered, overrides <code>closeOnActionTrigger</code> prop set on <code>Spotlight</code>",
        "name": "closeSpotlightOnTrigger",
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "description": {
        "description": "Action description, pass string to use in default filter",
        "name": "description",
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "dimmedSections": {
        "description": "Determines whether left and right sections should have dimmed styles, <code>true</code> by default",
        "name": "dimmedSections",
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "highlightColor": {
        "description": "Key of <code>theme.colors</code> of any valid CSS color that will be used to highlight search query, <code>'yellow'</code> by default",
        "name": "highlightColor",
        "required": false,
        "type": {
          "name": "MantineColor"
        }
      },
      "highlightQuery": {
        "description": "Determines whether search query should be highlighted in action label, <code>false</code> by default",
        "name": "highlightQuery",
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "keywords": {
        "description": "Keywords that are used for default filtering, not displayed anywhere, can be a string: \"react,router,javascript\" or an array: ['react', 'router', 'javascript']",
        "name": "keywords",
        "required": false,
        "type": {
          "name": "string | string[]"
        }
      },
      "label": {
        "description": "Action label, pass string to use in default filter",
        "name": "label",
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "leftSection": {
        "description": "Section displayed on the left side of the label, for example, icon",
        "name": "leftSection",
        "required": false,
        "type": {
          "name": "React.ReactNode"
        }
      },
      "rightSection": {
        "description": "Section displayed on the right side of the label, for example, hotkey",
        "name": "rightSection",
        "required": false,
        "type": {
          "name": "React.ReactNode"
        }
      }
    }
  },
  "@it-corp/vpbank-core/SpotlightActionsGroup": {
    "props": {
      "children": {
        "description": "<code>Spotlight.Action</code> components",
        "name": "children",
        "required": false,
        "type": {
          "name": "React.ReactNode"
        }
      },
      "label": {
        "description": "Group label",
        "name": "label",
        "required": false,
        "type": {
          "name": "React.ReactNode"
        }
      }
    }
  },
  "@it-corp/vpbank-spotlight/SpotlightRoot": {
    "props": {
      "clearQueryOnClose": {
        "description": "Determines whether the search query should be cleared when the spotlight is closed, <code>true</code> by default",
        "name": "clearQueryOnClose",
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "closeOnActionTrigger": {
        "description": "Determines whether spotlight should be closed when one of the actions is triggered, <code>true</code> by default",
        "name": "closeOnActionTrigger",
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "disabled": {
        "description": "If set, spotlight will not be rendered",
        "name": "disabled",
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "forceOpened": {
        "description": "Forces opened state, useful for tests",
        "name": "forceOpened",
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "maxHeight": {
        "description": "Spotlight content max-height. Ignored unless <code>scrollable</code> prop is set. <code>400</code> by default",
        "name": "maxHeight",
        "required": false,
        "type": {
          "name": "MaxHeight<string | number>"
        }
      },
      "onQueryChange": {
        "description": "Called when query changes",
        "name": "onQueryChange",
        "required": false,
        "type": {
          "name": "((query: string) => void)"
        }
      },
      "onSpotlightClose": {
        "description": "Called when spotlight closes",
        "name": "onSpotlightClose",
        "required": false,
        "type": {
          "name": "(() => void)"
        }
      },
      "onSpotlightOpen": {
        "description": "Called when spotlight opens",
        "name": "onSpotlightOpen",
        "required": false,
        "type": {
          "name": "(() => void)"
        }
      },
      "query": {
        "description": "Controlled Spotlight search query",
        "name": "query",
        "required": false,
        "type": {
          "name": "string"
        }
      },
      "scrollable": {
        "description": "Determines whether the actions list should be scrollable. If not set, <code>maxHeight</code> is ignored, <code>false</code> by default",
        "name": "scrollable",
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "shortcut": {
        "description": "Keyboard shortcut or a list of shortcuts to trigger spotlight, <code>'mod + K'</code> by default",
        "name": "shortcut",
        "required": false,
        "type": {
          "name": "string | string[] | null"
        }
      },
      "store": {
        "description": "Spotlight store, can be used to create multiple instances of spotlight",
        "name": "store",
        "required": false,
        "type": {
          "name": "SpotlightStore"
        }
      },
      "tagsToIgnore": {
        "description": "A list of tags which when focused will be ignored by shortcut, <code>['input', 'textarea', 'select']</code> by default",
        "name": "tagsToIgnore",
        "required": false,
        "type": {
          "name": "string[]"
        }
      },
      "triggerOnContentEditable": {
        "description": "Determines whether shortcut should trigger based in contentEditable, <code>false</code> by default",
        "name": "triggerOnContentEditable",
        "required": false,
        "type": {
          "name": "boolean"
        }
      }
    }
  },
  "@it-corp/vpbank-spotlight/SpotlightSearch": {
    "description": "",
    "props": {}
  }
}