scottk/vault
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/vault.git synced 2025-11-01 19:17:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docfy for addon components (#27188)

Browse Source 
* move script to scripts folder

* add docfy to router and scripts

* add docfy to router and scripts

* fix jsdoc syntax

* add component markdown files to gitignore

* improve error handling for scripts

* tidy up remaining jsdoc syntax

* add sample jsdoc components

* add known issue info

* make not using multi-line components clearer

* make generating docs clearer

* update copy

* final how to docfy cleanup

* fix ts file @module syntax

* fix read more syntax

* make docfy typescript compatible
This commit is contained in:
claire bontempo
2024-05-29 14:06:38 -07:00
committed by GitHub
parent fab2899508
commit e61bd967e3
70 changed files with 2932 additions and 512 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
ui/lib/core/addon/components/navigate-input.js
View File

@@ -19,21 +19,19 @@ import keys from 'core/utils/key-codes';
* `NavigateInput` components are used to filter list data.
*
* @example
* ```js
* <NavigateInput @filter={@roleFiltered} @placeholder="placeholder text" urls="{{hash list="vault.cluster.secrets.backend.kubernetes.roles"}}"/>
* ```
* <NavigateInput @filter={{@roleFiltered}} urls={{hash list="vault.cluster.secrets.backend.kubernetes.roles"}}/>
*
* @param {String} filter=null - The filtered string.
* @param {String} [placeholder="Filter items"] - The message inside the input to indicate what the user should enter into the space.
* @param {String} [placeholder=Filter items] - The message inside the input to indicate what the user should enter into the space.
* @param {Object} [urls=null] - An object containing list=route url.
* @param {Function} [filterFocusDidChange=null] - A function called when the focus changes.
* @param {Function} [filterDidChange=null] - A function called when the filter string changes.
* @param {Function} [filterMatchesKey=null] - A function used to match to a specific key, such as an Id.
* @param {Function} [filterPartialMatch=null] - A function used to filter through a partial match. Such as "oo" of "root".
* @param {String} [baseKey=""] - A string to transition by Id.
* @param {String} [baseKey] - A string to transition by Id.
* @param {Boolean} [shouldNavigateTree=false] - If true, navigate a larger tree, such as when you're navigating leases under access.
* @param {String} [mode="secrets"] - Mode which plays into navigation type.
* @param {String} [extraNavParams=""] - A string used in route transition when necessary.
* @param {String} [mode=secrets] - Mode which plays into navigation type.
* @param {String} [extraNavParams] - A string used in route transition when necessary.
*/
const routeFor = function (type, mode, urls) {