https://github.com/aholachek/storybook-mobile

[Deprecated] A storybook addon that helps you create truly mobile-friendly components
https://github.com/aholachek/storybook-mobile

deprecated mobile-web reactjs storybook storybook-addon ux

Last synced: 16 days ago
JSON representation

[Deprecated] A storybook addon that helps you create truly mobile-friendly components

• Host: GitHub
• URL: https://github.com/aholachek/storybook-mobile
• Owner: aholachek
• Created: 2020-04-12T19:17:59.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-03T03:06:43.000Z (about 2 years ago)
• Last Synced: 2025-03-30T21:11:16.078Z (23 days ago)
• Topics: deprecated, mobile-web, reactjs, storybook, storybook-addon, ux
• Language: JavaScript
• Homepage:
• Size: 21.9 MB
• Stars: 106
• Watchers: 2
• Forks: 9
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 📱storybook-mobile

[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/) [![npm version](https://badge.fury.io/js/storybook-mobile.svg)](https://badge.fury.io/js/storybook-mobile)

# Deprecated!

**Mobile web best practices are constantly evolving, and I haven't had the time to make the necessary updates to keep the warnings and hints up-to-date.

Please feel free to fork this library. I don't recommend using this add-on for new projects.**

## Original readme:

This addon offers suggestions on how you can improve the HTML, CSS and UX of your components to be more mobile-friendly.







[To see all available suggestions, check out a live storybook demo here.](https://storybook-mobile.netlify.app/?path=/story/signup-form--default)

## Quick Start

`yarn add -D storybook-mobile` or `npm install --save-dev storybook-mobile`

Next, add `storybook-mobile` to your list of addons:

`.storybook/main.js`

```diff

module.exports = {

  // other config goes here

  addons: [

+    'storybook-mobile'

  ],

}

```

This addon works best along with the [@storybook/addon-viewport](https://github.com/storybookjs/storybook/tree/next/addons/viewport) addon, so please install that as well if you don't have it already.

## Contributing

If you have any suggestions or find any bugs, please make an issue or a pr!

**NOTE**: While developing this addon locally, if you are using npm