wikimedia/mediawiki-extensions-Popups
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups synced 2024-11-15 11:46:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Popups/.storybook/README.md
Jan Drewniak 83a28d177f Storybook.js for Popups 
Storybook.js provides a framework for
viewing and working with UI components.
https://storybook.js.org/

This patch adds the Storybook.js UI library to Popups for
the purposes of viewing multiple previews at once.
This enables viewing page previews in the following states:

- with thumbnails
- without thumbnails
- with SVG thumbnails
- with narrow thumbnails
- with white background thumbnails
- in RTL languages
- in non-latin languages
- disambiguation popups

Storybook also allows users to change the image or text
of a popup through a GUI.

This patch sets up Storybook as a "mini" repo inside
the.storybook folder with a seperate package.json file
to avoid incompatibilities with the current webpack/babel
(or even Node) versions used in the Popups repo.

Storybook requires at least Node v8.3 to run.
(an .nvmrc file with 11.3.0 has been added to the .stories dir).

To start:
`cd .storybook && npm install && npm run start`.

Bug: T205989
Change-Id: I041e46c4f0cf173950015067e2dce81c023d3fdd
2019-01-08 14:19:00 +01:00

755 B
Raw Blame History

StoryPops - Storybook for Popups

This "mini-project" contains all the dependencies and code to run a Storybook app (https://storybook.js.org/) for the Popups repository.

Quickstart: npm install && npm run start visit http://localhost:6006

NOTE: This project requires a different version of Node then the main Popups project. NVM is recommended to manage these versions. (cd .storybook && nvm use)

This project is configured to run separately from the main Popups project because it requires at least Node v8.4, whereas Popups (currently) runs Node 6 for consistency with C.I.

When the Popups Node version is upgraded, the Storybook dependencies can be moved into the main Popups package.json file and the one in this folder can be removed.