golem
/
VectorGOLEM
9
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity
VectorGOLEM/stories/skin.stories.js

81 lines
4.1 KiB
JavaScript
Raw Normal View History

Add storybook to Vector - Update package.json with the new dependencies. - A script storybook.sh pulls down CSS and LESS imports from external dependencies. This copies the approach taken in Popups and MobileFrontend. - Icons from external repos are maintained within the repo in SVG-only form. Using load.php modules is also possible, but will pull down other unnecessary icons and break if any of these modules are changed. Decided that we should manually maintain these for the time being given there are only 3 icons. - Several LESS files now import the variables file. I think it's useful for stories to only import the CSS they use as this encourages us to modularise our CSS. Before these imports were not necessary as they inherit imports from index.less. This will have no impact on the bundle size as the LESS compiler silently discards duplicate imports - stories/utils.js provides a useful placeholder function for generalising our hook entry points. Bug: T242674 Change-Id: I722e84d2fb57653a2f96142dc3e5248043261746
2020-01-09 22:11:00 +00:00
import mustache from 'mustache';
import { htmluserlangattributes } from './utils';
import skinTemplate from '!!raw-loader!../includes/templates/index.mustache';
import { placeholder } from './utils';
[dev] Consolidate ResourceLoader LESS style files Move styles.less to index.less and import print.less from it. This keeps the reasoning about styles constrained to LESS instead of spread out over LESS _and_ ResourceLoader. The former is preferable since LESS is more standardized than ResourceLoader. The approach of moving styles.less to index.less and then referencing print.less was chosen with the intent that it'd be easier to assume styles are screen styles unless a media query says otherwise. This patch also makes the variables import common among print and screen styles. Bug: T246419 Change-Id: I981d0937aaacb7cba082c337f98c90e90b46b340
2020-03-10 21:01:09 +00:00
import '../resources/skins.vector.styles/index.less';
Rename Storybook Files to Reflect Their Respective Component * Following up on the work from Idf90ee2a0f1c1d08a31cf50099c0bebc7b67e619, this commit renames the storybook files/storybook names to their respective component name. e.g. personalNavigation.stories.js => PersonalMenu.stories.js Bug: T243281 Change-Id: I68054663c5a597f90a826b6f75bf399382dca609
2020-02-28 22:17:31 +00:00
import { NAVIGATION_TEMPLATE_DATA, navTemplate, NAVIGATION_TEMPLATE_PARTIALS } from './Navigation.stories.data';
import { FOOTER_TEMPLATE_DATA, footerTemplate } from './Footer.stories.data';
Use template partials rather than HTML strings CHANGES to index.mustache: Changes can be understood by looking at the diff of the file stories/skin.stories.js The additional changes in stories folder export the data passed to those templates. A new file is used as exporting any variable in a file suffixed stories.js will be assumed to be a story entry. The changes to index.mustache are as follows: * html-footer is replaced with data-footer and Footer component is rendered via template partial * html-navigation is replaced with data-navigation and Navigation component is rendered via template partial CHANGES to Navigation.mustache: Changes are best explained by looking at the diff to stories/navigation.stories.js and navigation.stories.data.js * html-personal-menu is replaced with data-personal-menu Bug: T245456 Change-Id: Ie96e92447a932b8a7f3844df277a1d31a2af423c
2020-02-17 19:49:43 +00:00
const TEMPLATE_PARTIALS = Object.assign( {}, NAVIGATION_TEMPLATE_PARTIALS, {
Navigation: navTemplate,
Footer: footerTemplate
} );
Add storybook to Vector - Update package.json with the new dependencies. - A script storybook.sh pulls down CSS and LESS imports from external dependencies. This copies the approach taken in Popups and MobileFrontend. - Icons from external repos are maintained within the repo in SVG-only form. Using load.php modules is also possible, but will pull down other unnecessary icons and break if any of these modules are changed. Decided that we should manually maintain these for the time being given there are only 3 icons. - Several LESS files now import the variables file. I think it's useful for stories to only import the CSS they use as this encourages us to modularise our CSS. Before these imports were not necessary as they inherit imports from index.less. This will have no impact on the bundle size as the LESS compiler silently discards duplicate imports - stories/utils.js provides a useful placeholder function for generalising our hook entry points. Bug: T242674 Change-Id: I722e84d2fb57653a2f96142dc3e5248043261746
2020-01-09 22:11:00 +00:00
export default {
title: 'Skin'
};
const HTML_INDICATORS = `<div class="mw-indicators mw-body-content">
<div id="mw-indicator-good-star" class="mw-indicator">
<a href="/wiki/Wikipedia:Good_articles"
title="This is a good article. Follow the link for more information.">
<img alt="This is a good article. Follow the link for more information."
src="//upload.wikimedia.org/wikipedia/en/thumb/9/94/Symbol_support_vote.svg/19px-Symbol_support_vote.svg.png" decoding="async" width="19" height="20"
srcset="//upload.wikimedia.org/wikipedia/en/thumb/9/94/Symbol_support_vote.svg/29px-Symbol_support_vote.svg.png 1.5x, //upload.wikimedia.org/wikipedia/en/thumb/9/94/Symbol_support_vote.svg/39px-Symbol_support_vote.svg.png 2x" data-file-width="180" data-file-height="185" />
</a>
</div>
<div id="mw-indicator-pp-autoreview" class="mw-indicator">
<a href="/wiki/Wikipedia:Protection_policy#pending"
title="All edits by unregistered and new users are subject to review prior to becoming visible to unregistered users">
<img alt="Page protected with pending changes" src="//upload.wikimedia.org/wikipedia/en/thumb/b/b7/Pending-protection-shackle.svg/20px-Pending-protection-shackle.svg.png"
decoding="async" width="20" height="20" srcset="//upload.wikimedia.org/wikipedia/en/thumb/b/b7/Pending-protection-shackle.svg/30px-Pending-protection-shackle.svg.png 1.5x, //upload.wikimedia.org/wikipedia/en/thumb/b/b7/Pending-protection-shackle.svg/40px-Pending-protection-shackle.svg.png 2x" data-file-width="512" data-file-height="512" />
</a>
</div>
</div>
`;
export const vector2019LoggedOut = () => mustache.render( skinTemplate, {
'html-title': 'Vector 2019',
'page-isarticle': true,
'msg-tagline': 'From Wikipedia, the free encyclopedia',
'html-userlangattributes': htmluserlangattributes,
'msg-jumptonavigation': 'Jump to navigation',
'msg-jumptosearch': 'Jump to search',
Use template partials rather than HTML strings CHANGES to index.mustache: Changes can be understood by looking at the diff of the file stories/skin.stories.js The additional changes in stories folder export the data passed to those templates. A new file is used as exporting any variable in a file suffixed stories.js will be assumed to be a story entry. The changes to index.mustache are as follows: * html-footer is replaced with data-footer and Footer component is rendered via template partial * html-navigation is replaced with data-navigation and Navigation component is rendered via template partial CHANGES to Navigation.mustache: Changes are best explained by looking at the diff to stories/navigation.stories.js and navigation.stories.data.js * html-personal-menu is replaced with data-personal-menu Bug: T245456 Change-Id: Ie96e92447a932b8a7f3844df277a1d31a2af423c
2020-02-17 19:49:43 +00:00
'data-navigation': NAVIGATION_TEMPLATE_DATA.loggedOutWithVariants,
Add storybook to Vector - Update package.json with the new dependencies. - A script storybook.sh pulls down CSS and LESS imports from external dependencies. This copies the approach taken in Popups and MobileFrontend. - Icons from external repos are maintained within the repo in SVG-only form. Using load.php modules is also possible, but will pull down other unnecessary icons and break if any of these modules are changed. Decided that we should manually maintain these for the time being given there are only 3 icons. - Several LESS files now import the variables file. I think it's useful for stories to only import the CSS they use as this encourages us to modularise our CSS. Before these imports were not necessary as they inherit imports from index.less. This will have no impact on the bundle size as the LESS compiler silently discards duplicate imports - stories/utils.js provides a useful placeholder function for generalising our hook entry points. Bug: T242674 Change-Id: I722e84d2fb57653a2f96142dc3e5248043261746
2020-01-09 22:11:00 +00:00
// site specific
Use template partials rather than HTML strings CHANGES to index.mustache: Changes can be understood by looking at the diff of the file stories/skin.stories.js The additional changes in stories folder export the data passed to those templates. A new file is used as exporting any variable in a file suffixed stories.js will be assumed to be a story entry. The changes to index.mustache are as follows: * html-footer is replaced with data-footer and Footer component is rendered via template partial * html-navigation is replaced with data-navigation and Navigation component is rendered via template partial CHANGES to Navigation.mustache: Changes are best explained by looking at the diff to stories/navigation.stories.js and navigation.stories.data.js * html-personal-menu is replaced with data-personal-menu Bug: T245456 Change-Id: Ie96e92447a932b8a7f3844df277a1d31a2af423c
2020-02-17 19:49:43 +00:00
'data-footer': FOOTER_TEMPLATE_DATA,
Add storybook to Vector - Update package.json with the new dependencies. - A script storybook.sh pulls down CSS and LESS imports from external dependencies. This copies the approach taken in Popups and MobileFrontend. - Icons from external repos are maintained within the repo in SVG-only form. Using load.php modules is also possible, but will pull down other unnecessary icons and break if any of these modules are changed. Decided that we should manually maintain these for the time being given there are only 3 icons. - Several LESS files now import the variables file. I think it's useful for stories to only import the CSS they use as this encourages us to modularise our CSS. Before these imports were not necessary as they inherit imports from index.less. This will have no impact on the bundle size as the LESS compiler silently discards duplicate imports - stories/utils.js provides a useful placeholder function for generalising our hook entry points. Bug: T242674 Change-Id: I722e84d2fb57653a2f96142dc3e5248043261746
2020-01-09 22:11:00 +00:00
'html-sitenotice': placeholder( 'a site notice or central notice banner may go here', 70 ),
// article dependent
'html-bodycontent': placeholder( 'Article content goes here' ),
'html-printfooter': `Retrieved from ‘<a dir="ltr" href="#">https://en.wikipedia.org/w/index.php?title=this&oldid=blah</a>’`,
'html-catlinks': placeholder( 'Category links component from mediawiki core', 50 ),
// extension dependent..
'html-hook-vector-before-footer': placeholder( 'VectorBeforeFooter hook output', 100 ),
'html-dataAfterContent': placeholder( 'Extensions can add here e.g. Related Articles.', 100 ),
'html-indicators': HTML_INDICATORS,
'html-subtitle': placeholder( 'Extensions can configure subtitle', 20 )
Use template partials rather than HTML strings CHANGES to index.mustache: Changes can be understood by looking at the diff of the file stories/skin.stories.js The additional changes in stories folder export the data passed to those templates. A new file is used as exporting any variable in a file suffixed stories.js will be assumed to be a story entry. The changes to index.mustache are as follows: * html-footer is replaced with data-footer and Footer component is rendered via template partial * html-navigation is replaced with data-navigation and Navigation component is rendered via template partial CHANGES to Navigation.mustache: Changes are best explained by looking at the diff to stories/navigation.stories.js and navigation.stories.data.js * html-personal-menu is replaced with data-personal-menu Bug: T245456 Change-Id: Ie96e92447a932b8a7f3844df277a1d31a2af423c
2020-02-17 19:49:43 +00:00
}, TEMPLATE_PARTIALS );
Add storybook to Vector - Update package.json with the new dependencies. - A script storybook.sh pulls down CSS and LESS imports from external dependencies. This copies the approach taken in Popups and MobileFrontend. - Icons from external repos are maintained within the repo in SVG-only form. Using load.php modules is also possible, but will pull down other unnecessary icons and break if any of these modules are changed. Decided that we should manually maintain these for the time being given there are only 3 icons. - Several LESS files now import the variables file. I think it's useful for stories to only import the CSS they use as this encourages us to modularise our CSS. Before these imports were not necessary as they inherit imports from index.less. This will have no impact on the bundle size as the LESS compiler silently discards duplicate imports - stories/utils.js provides a useful placeholder function for generalising our hook entry points. Bug: T242674 Change-Id: I722e84d2fb57653a2f96142dc3e5248043261746
2020-01-09 22:11:00 +00:00
export const vector2019LoggedIn = () => mustache.render( skinTemplate, {
'html-title': 'Vector 2019',
'page-isarticle': true,
'msg-tagline': 'From Wikipedia, the free encyclopedia',
'html-userlangattributes': htmluserlangattributes,
'msg-jumptonavigation': 'Jump to navigation',
'msg-jumptosearch': 'Jump to search',
Use template partials rather than HTML strings CHANGES to index.mustache: Changes can be understood by looking at the diff of the file stories/skin.stories.js The additional changes in stories folder export the data passed to those templates. A new file is used as exporting any variable in a file suffixed stories.js will be assumed to be a story entry. The changes to index.mustache are as follows: * html-footer is replaced with data-footer and Footer component is rendered via template partial * html-navigation is replaced with data-navigation and Navigation component is rendered via template partial CHANGES to Navigation.mustache: Changes are best explained by looking at the diff to stories/navigation.stories.js and navigation.stories.data.js * html-personal-menu is replaced with data-personal-menu Bug: T245456 Change-Id: Ie96e92447a932b8a7f3844df277a1d31a2af423c
2020-02-17 19:49:43 +00:00
'data-navigation': NAVIGATION_TEMPLATE_DATA.loggedInWithMoreActions,
Add storybook to Vector - Update package.json with the new dependencies. - A script storybook.sh pulls down CSS and LESS imports from external dependencies. This copies the approach taken in Popups and MobileFrontend. - Icons from external repos are maintained within the repo in SVG-only form. Using load.php modules is also possible, but will pull down other unnecessary icons and break if any of these modules are changed. Decided that we should manually maintain these for the time being given there are only 3 icons. - Several LESS files now import the variables file. I think it's useful for stories to only import the CSS they use as this encourages us to modularise our CSS. Before these imports were not necessary as they inherit imports from index.less. This will have no impact on the bundle size as the LESS compiler silently discards duplicate imports - stories/utils.js provides a useful placeholder function for generalising our hook entry points. Bug: T242674 Change-Id: I722e84d2fb57653a2f96142dc3e5248043261746
2020-01-09 22:11:00 +00:00
// site specific
Use template partials rather than HTML strings CHANGES to index.mustache: Changes can be understood by looking at the diff of the file stories/skin.stories.js The additional changes in stories folder export the data passed to those templates. A new file is used as exporting any variable in a file suffixed stories.js will be assumed to be a story entry. The changes to index.mustache are as follows: * html-footer is replaced with data-footer and Footer component is rendered via template partial * html-navigation is replaced with data-navigation and Navigation component is rendered via template partial CHANGES to Navigation.mustache: Changes are best explained by looking at the diff to stories/navigation.stories.js and navigation.stories.data.js * html-personal-menu is replaced with data-personal-menu Bug: T245456 Change-Id: Ie96e92447a932b8a7f3844df277a1d31a2af423c
2020-02-17 19:49:43 +00:00
'data-footer': FOOTER_TEMPLATE_DATA,
Add storybook to Vector - Update package.json with the new dependencies. - A script storybook.sh pulls down CSS and LESS imports from external dependencies. This copies the approach taken in Popups and MobileFrontend. - Icons from external repos are maintained within the repo in SVG-only form. Using load.php modules is also possible, but will pull down other unnecessary icons and break if any of these modules are changed. Decided that we should manually maintain these for the time being given there are only 3 icons. - Several LESS files now import the variables file. I think it's useful for stories to only import the CSS they use as this encourages us to modularise our CSS. Before these imports were not necessary as they inherit imports from index.less. This will have no impact on the bundle size as the LESS compiler silently discards duplicate imports - stories/utils.js provides a useful placeholder function for generalising our hook entry points. Bug: T242674 Change-Id: I722e84d2fb57653a2f96142dc3e5248043261746
2020-01-09 22:11:00 +00:00
'html-sitenotice': placeholder( 'a site notice or central notice banner may go here', 70 ),
// article dependent
'html-bodycontent': placeholder( 'Article content goes here' ),
'html-printfooter': `Retrieved from ‘<a dir="ltr" href="#">https://en.wikipedia.org/w/index.php?title=this&oldid=blah</a>’`,
'html-catlinks': placeholder( 'Category links component from mediawiki core', 50 )
Use template partials rather than HTML strings CHANGES to index.mustache: Changes can be understood by looking at the diff of the file stories/skin.stories.js The additional changes in stories folder export the data passed to those templates. A new file is used as exporting any variable in a file suffixed stories.js will be assumed to be a story entry. The changes to index.mustache are as follows: * html-footer is replaced with data-footer and Footer component is rendered via template partial * html-navigation is replaced with data-navigation and Navigation component is rendered via template partial CHANGES to Navigation.mustache: Changes are best explained by looking at the diff to stories/navigation.stories.js and navigation.stories.data.js * html-personal-menu is replaced with data-personal-menu Bug: T245456 Change-Id: Ie96e92447a932b8a7f3844df277a1d31a2af423c
2020-02-17 19:49:43 +00:00
}, TEMPLATE_PARTIALS );