VectorGOLEM/stories/types.js

47 lines
1.4 KiB
JavaScript

/**
* @typedef {Object} LogoOptions
* @prop {string} src of logo. Can be relative, absolute or data uri.
* @prop {string} [alt] text of logo.
* @prop {number} width of asset
* @prop {number} height of asset
*/
/**
* @typedef {Object} ResourceLoaderSkinModuleLogos
* @prop {string} [icon] e.g. Wikipedia globe
* @prop {LogoOptions} [wordmark] e.g. Legacy Vector logo
* @prop {LogoOptions} [tagline] e.g. Legacy Vector logo
*/
/**
* @typedef {Object} LogoTemplateData
* @prop {ResourceLoaderSkinModuleLogos} data-logos as configured,
* the return value of ResourceLoaderSkinModule::getAvailableLogos.
* @prop {string} msg-sitetitle alternate text for wordmark
href the url to navigate to on click.
* @prop {string} msg-sitesubtitle alternate text for tagline.
*/
/**
* @typedef {Object} MenuDefinition
* @prop {string} id
* @prop {string} label-id
* @prop {string} label
* @prop {string} html-items
* @prop {string} [class] of menu
* @prop {string} [html-userlangattributes]
* @prop {boolean} [is-dropdown]
*/
/**
* @typedef {Object} PortletContext
* @prop {string} portal-id
* @prop {string} html-tooltip
* @prop {string} msg-label-id
* @prop {string} [html-userlangattributes]
* @prop {string} msg-label
* @prop {string} html-portal-content
* @prop {string} [html-after-portal]
* @prop {string} [html-hook-vector-after-toolbox] Deprecated and used by the toolbox portal.
*/