2020-06-03 19:41:59 +00:00
|
|
|
/**
|
|
|
|
* @typedef {Object} Indicator
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {string} html of the indicator link.
|
|
|
|
* @property {string} id of the indicator.
|
|
|
|
* @property {string} class of the indicator
|
2020-06-03 19:41:59 +00:00
|
|
|
*/
|
|
|
|
|
[modern] A new version of Vector with a new logo
Changes to support feature:
* ResourceLoaderSkinModule logo features are dropped
* New layout provided given the fork in layout between legacy and new.
* Legacy sidebar styles now pulled out
* breakpoint styles are not carried over from legacy Vector
The new Vector layout for now has one breakpoint.
Changes to storybook:
* The storybook script now pulls down image assets so that the logos can
be shown in storybook. The script is adjusted to make use of a static folder to
serve these images.
Note:
* The legacy mode is not touched as part of this patchset.
* The personal menu is unaffected by this patch and is out of scope.
* The alignment issue is noted, but will be solved at a later date.
* Changes to portal are out of scope.
* Adding storybook for modern descoped, given its not possible to load
both legacy layout and modern layout inside a storybook at current time.
Sample config:
$wgLogos = [
'icon' => 'https://di-logo-sandbox.firebaseapp.com/img/globe.png',
'tagline' => [
'src' => 'https://di-logo-sandbox.firebaseapp.com/img/tagline/en-tagline-117-13.svg',
'width' => 117,
'height' => 13,
],
'1x' => 'https://en.wikipedia.org/static/images/project-logos/enwiki.png',
'wordmark' => [
'src' => 'https://en.wikipedia.org/static/images/mobile/copyright/wikipedia-wordmark-en.svg',
'width' => 116,
'height' => 18,
],
];
Coauthor: Aron Manning
Bug: T246170
Change-Id: Ibc4b055150761388a6b78f9127da342c451ce0e7
2020-03-09 05:51:00 +00:00
|
|
|
/**
|
|
|
|
* @typedef {Object} LogoOptions
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {string} src of logo. Can be relative, absolute or data uri.
|
|
|
|
* @property {string} [alt] text of logo.
|
|
|
|
* @property {number} width of asset
|
|
|
|
* @property {number} height of asset
|
[modern] A new version of Vector with a new logo
Changes to support feature:
* ResourceLoaderSkinModule logo features are dropped
* New layout provided given the fork in layout between legacy and new.
* Legacy sidebar styles now pulled out
* breakpoint styles are not carried over from legacy Vector
The new Vector layout for now has one breakpoint.
Changes to storybook:
* The storybook script now pulls down image assets so that the logos can
be shown in storybook. The script is adjusted to make use of a static folder to
serve these images.
Note:
* The legacy mode is not touched as part of this patchset.
* The personal menu is unaffected by this patch and is out of scope.
* The alignment issue is noted, but will be solved at a later date.
* Changes to portal are out of scope.
* Adding storybook for modern descoped, given its not possible to load
both legacy layout and modern layout inside a storybook at current time.
Sample config:
$wgLogos = [
'icon' => 'https://di-logo-sandbox.firebaseapp.com/img/globe.png',
'tagline' => [
'src' => 'https://di-logo-sandbox.firebaseapp.com/img/tagline/en-tagline-117-13.svg',
'width' => 117,
'height' => 13,
],
'1x' => 'https://en.wikipedia.org/static/images/project-logos/enwiki.png',
'wordmark' => [
'src' => 'https://en.wikipedia.org/static/images/mobile/copyright/wikipedia-wordmark-en.svg',
'width' => 116,
'height' => 18,
],
];
Coauthor: Aron Manning
Bug: T246170
Change-Id: Ibc4b055150761388a6b78f9127da342c451ce0e7
2020-03-09 05:51:00 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @typedef {Object} ResourceLoaderSkinModuleLogos
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {string} [icon] e.g. Wikipedia globe
|
|
|
|
* @property {LogoOptions} [wordmark] e.g. Legacy Vector logo
|
|
|
|
* @property {LogoOptions} [tagline] e.g. Legacy Vector logo
|
[modern] A new version of Vector with a new logo
Changes to support feature:
* ResourceLoaderSkinModule logo features are dropped
* New layout provided given the fork in layout between legacy and new.
* Legacy sidebar styles now pulled out
* breakpoint styles are not carried over from legacy Vector
The new Vector layout for now has one breakpoint.
Changes to storybook:
* The storybook script now pulls down image assets so that the logos can
be shown in storybook. The script is adjusted to make use of a static folder to
serve these images.
Note:
* The legacy mode is not touched as part of this patchset.
* The personal menu is unaffected by this patch and is out of scope.
* The alignment issue is noted, but will be solved at a later date.
* Changes to portal are out of scope.
* Adding storybook for modern descoped, given its not possible to load
both legacy layout and modern layout inside a storybook at current time.
Sample config:
$wgLogos = [
'icon' => 'https://di-logo-sandbox.firebaseapp.com/img/globe.png',
'tagline' => [
'src' => 'https://di-logo-sandbox.firebaseapp.com/img/tagline/en-tagline-117-13.svg',
'width' => 117,
'height' => 13,
],
'1x' => 'https://en.wikipedia.org/static/images/project-logos/enwiki.png',
'wordmark' => [
'src' => 'https://en.wikipedia.org/static/images/mobile/copyright/wikipedia-wordmark-en.svg',
'width' => 116,
'height' => 18,
],
];
Coauthor: Aron Manning
Bug: T246170
Change-Id: Ibc4b055150761388a6b78f9127da342c451ce0e7
2020-03-09 05:51:00 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @typedef {Object} LogoTemplateData
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {ResourceLoaderSkinModuleLogos} data-logos as configured,
|
[modern] A new version of Vector with a new logo
Changes to support feature:
* ResourceLoaderSkinModule logo features are dropped
* New layout provided given the fork in layout between legacy and new.
* Legacy sidebar styles now pulled out
* breakpoint styles are not carried over from legacy Vector
The new Vector layout for now has one breakpoint.
Changes to storybook:
* The storybook script now pulls down image assets so that the logos can
be shown in storybook. The script is adjusted to make use of a static folder to
serve these images.
Note:
* The legacy mode is not touched as part of this patchset.
* The personal menu is unaffected by this patch and is out of scope.
* The alignment issue is noted, but will be solved at a later date.
* Changes to portal are out of scope.
* Adding storybook for modern descoped, given its not possible to load
both legacy layout and modern layout inside a storybook at current time.
Sample config:
$wgLogos = [
'icon' => 'https://di-logo-sandbox.firebaseapp.com/img/globe.png',
'tagline' => [
'src' => 'https://di-logo-sandbox.firebaseapp.com/img/tagline/en-tagline-117-13.svg',
'width' => 117,
'height' => 13,
],
'1x' => 'https://en.wikipedia.org/static/images/project-logos/enwiki.png',
'wordmark' => [
'src' => 'https://en.wikipedia.org/static/images/mobile/copyright/wikipedia-wordmark-en.svg',
'width' => 116,
'height' => 18,
],
];
Coauthor: Aron Manning
Bug: T246170
Change-Id: Ibc4b055150761388a6b78f9127da342c451ce0e7
2020-03-09 05:51:00 +00:00
|
|
|
* the return value of ResourceLoaderSkinModule::getAvailableLogos.
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {string} msg-sitetitle alternate text for wordmark
|
[modern] A new version of Vector with a new logo
Changes to support feature:
* ResourceLoaderSkinModule logo features are dropped
* New layout provided given the fork in layout between legacy and new.
* Legacy sidebar styles now pulled out
* breakpoint styles are not carried over from legacy Vector
The new Vector layout for now has one breakpoint.
Changes to storybook:
* The storybook script now pulls down image assets so that the logos can
be shown in storybook. The script is adjusted to make use of a static folder to
serve these images.
Note:
* The legacy mode is not touched as part of this patchset.
* The personal menu is unaffected by this patch and is out of scope.
* The alignment issue is noted, but will be solved at a later date.
* Changes to portal are out of scope.
* Adding storybook for modern descoped, given its not possible to load
both legacy layout and modern layout inside a storybook at current time.
Sample config:
$wgLogos = [
'icon' => 'https://di-logo-sandbox.firebaseapp.com/img/globe.png',
'tagline' => [
'src' => 'https://di-logo-sandbox.firebaseapp.com/img/tagline/en-tagline-117-13.svg',
'width' => 117,
'height' => 13,
],
'1x' => 'https://en.wikipedia.org/static/images/project-logos/enwiki.png',
'wordmark' => [
'src' => 'https://en.wikipedia.org/static/images/mobile/copyright/wikipedia-wordmark-en.svg',
'width' => 116,
'height' => 18,
],
];
Coauthor: Aron Manning
Bug: T246170
Change-Id: Ibc4b055150761388a6b78f9127da342c451ce0e7
2020-03-09 05:51:00 +00:00
|
|
|
href the url to navigate to on click.
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {string} msg-sitesubtitle alternate text for tagline.
|
[modern] A new version of Vector with a new logo
Changes to support feature:
* ResourceLoaderSkinModule logo features are dropped
* New layout provided given the fork in layout between legacy and new.
* Legacy sidebar styles now pulled out
* breakpoint styles are not carried over from legacy Vector
The new Vector layout for now has one breakpoint.
Changes to storybook:
* The storybook script now pulls down image assets so that the logos can
be shown in storybook. The script is adjusted to make use of a static folder to
serve these images.
Note:
* The legacy mode is not touched as part of this patchset.
* The personal menu is unaffected by this patch and is out of scope.
* The alignment issue is noted, but will be solved at a later date.
* Changes to portal are out of scope.
* Adding storybook for modern descoped, given its not possible to load
both legacy layout and modern layout inside a storybook at current time.
Sample config:
$wgLogos = [
'icon' => 'https://di-logo-sandbox.firebaseapp.com/img/globe.png',
'tagline' => [
'src' => 'https://di-logo-sandbox.firebaseapp.com/img/tagline/en-tagline-117-13.svg',
'width' => 117,
'height' => 13,
],
'1x' => 'https://en.wikipedia.org/static/images/project-logos/enwiki.png',
'wordmark' => [
'src' => 'https://en.wikipedia.org/static/images/mobile/copyright/wikipedia-wordmark-en.svg',
'width' => 116,
'height' => 18,
],
];
Coauthor: Aron Manning
Bug: T246170
Change-Id: Ibc4b055150761388a6b78f9127da342c451ce0e7
2020-03-09 05:51:00 +00:00
|
|
|
*/
|
|
|
|
|
2020-06-22 18:01:10 +00:00
|
|
|
/**
|
|
|
|
* @typedef {Object} SidebarData
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {MenuDefinition} data-portals-languages
|
2020-09-04 19:18:57 +00:00
|
|
|
* @property {MenuDefinition} data-portlets-first
|
|
|
|
* @property {MenuDefinition[]} array-portlets-rest
|
2020-06-22 18:01:10 +00:00
|
|
|
*/
|
|
|
|
|
2020-05-29 19:07:55 +00:00
|
|
|
/**
|
|
|
|
* @typedef {Object} SearchData
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {string|null} msg-search
|
2021-09-16 18:00:05 +00:00
|
|
|
* @property {string|null} msg-searchbutton
|
|
|
|
* @property {string|null} msg-searcharticle
|
2020-07-14 21:40:28 +00:00
|
|
|
* @property {string} [html-user-language-attributes]
|
2021-09-16 18:00:05 +00:00
|
|
|
* @property {boolean} is-primary is this the primary method of search?
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {string} form-action URL
|
2021-09-16 18:00:05 +00:00
|
|
|
* @property {string} form-id
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {string|null} html-input
|
2021-06-02 22:57:43 +00:00
|
|
|
* @property {string|null} [class] of the menu
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {string|null} page-title the title of the search page
|
2021-09-16 18:00:05 +00:00
|
|
|
* @property {string} html-input-attributes
|
|
|
|
* @property {string} html-button-fulltext-attributes
|
|
|
|
* @property {string} html-button-go-attributes
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {string|null} html-button-search-fallback
|
|
|
|
* @property {string|null} html-button-search
|
2020-09-16 12:18:54 +00:00
|
|
|
* @property {string} [input-location] An identifier corresponding the position of the search
|
|
|
|
* widget on the page, e.g. "header-navigation"
|
2021-07-22 17:27:33 +00:00
|
|
|
* @property {boolean} [is-collapsible]
|
|
|
|
* @property {string} [href-search]
|
2020-05-29 19:07:55 +00:00
|
|
|
*/
|
|
|
|
|
2020-04-03 20:05:22 +00:00
|
|
|
/**
|
|
|
|
* @typedef {Object} MenuDefinition
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {string} id
|
|
|
|
* @property {string} label
|
|
|
|
* @property {string} html-items
|
2021-09-01 22:58:54 +00:00
|
|
|
* @property {string} [checkbox-class]
|
|
|
|
* @property {string} [html-vector-heading-icon]
|
2021-02-08 23:10:21 +00:00
|
|
|
* @property {string} [heading-class]
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {string} [html-tooltip]
|
|
|
|
* @property {string} [class] of menu
|
2020-07-14 21:40:28 +00:00
|
|
|
* @property {string} [html-user-language-attributes]
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {boolean} [is-dropdown]
|
2021-06-14 18:47:42 +00:00
|
|
|
* @property {string} [html-before-portal] Additional HTML specific to portal menus.
|
2020-06-08 22:14:37 +00:00
|
|
|
* @property {string} [html-after-portal] Additional HTML specific to portal menus.
|
2020-04-03 20:05:22 +00:00
|
|
|
*/
|
2021-05-26 23:23:53 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @typedef {Object.<string, MenuDefinition>} MenuDefinitions
|
|
|
|
*/
|
2021-05-07 21:56:29 +00:00
|
|
|
|
2021-05-27 21:47:55 +00:00
|
|
|
/**
|
|
|
|
* @typedef {Object} UserLinksDefinition
|
2021-06-02 22:57:43 +00:00
|
|
|
* @property {MenuDefinition} data-user-more
|
2021-06-03 21:37:01 +00:00
|
|
|
* @property {MenuDefinition} data-user-menu
|
2021-05-07 21:56:29 +00:00
|
|
|
*/
|