Responsive React UI components
npm install react-responsive-ui --save
`
React >= 16.3 is required.
Use
See the demo page. It has code examples for every component.
Demo
Online demo page.
To run the demo page locally:
`
npm run demo
`
And then go to http://localhost:8080
CSS
The CSS for this library resides in react-responsive-ui/style.css file and should be included on a page.
The stylesheet uses native CSS variables for easier styling. See variables.css for the list of all available variables. These variables have some sensible defaults which can be overridden:
`css
:root {
--rrui-unit : 12px;
--rrui-white-color : white;
--rrui-black-color : black;
--rrui-accent-color : blue;
--rrui-accent-color-light : cyan;
--rrui-gray-color : gray;
}
`
Native CSS variables work in all modern browsers, but older ones like Internet Explorer wont't support them. For compatibility with such older browsers one can use a CSS transformer like PostCSS with a "CSS custom properties" plugin like postcss-custom-properties.
#### When using Webpack
`js
// React Responsive UI.
require('react-responsive-ui/style.css')
// Custom variable values.
require('./src/styles/react-responsive-ui-custom-variable-values.css')
`
And set up a postcss-loader with a CSS autoprefixer for supporting old web browsers.
#### When not using Webpack
Get the style.css file from this package, process it with a CSS autoprefixer for supporting old web browsers, and then include it on a page.
`html
`
Small Screen
The small-screen directory contains "small screen" ("mobile devices") styles for some of the components. For example, s, s, s, s can open in fullscreen (not neccessarily a good idea though). s have less padding and s are full-width. These CSS files may also use native CSS variables.
Native CSS @import example:
`css
/ Main style. /
@import url(~react-responsive-ui/style.css)
/ Less padding on s on mobile devices. /
@import url(~react-responsive-ui/small-screen/Modal.css) (max-width: 768px)
/ Full-width s on mobile devices. /
@import url(~react-responsive-ui/small-screen/Snackbar.css) (max-width: 768px)
/* Places a click-capturing overlay above input
so that the is not focused on touch meaning that the
keyboard won't slide in when the user taps the input. */
@import url(~react-responsive-ui/small-screen/DatePicker.InputOverlay.css) (max-width: 768px)
`
Validation
Each form component can be passed an error: String property. When passed, the component will be styled as "invalid" and the error will be displayed under the component.
Asterisk on required fields
To show asterisks (*) on required fields' labels:
When field value is empty:
`css
/ (when the value is empty) /
/ Required input field labels will have asterisks. /
.rrui__input-label--required:after {
content: '*';
margin-left: 0.2em;
}
`
Regardless of whether the field value is empty or not:
`css
/ (regardless of whether the value is empty or not) /
/ Required input field labels will have asterisks. /
.rrui__input-label--required-field:after {
content: '*';
margin-left: 0.2em;
}
`
Supported Browsers
IE 11, Edge, Firefox, Chrome, Safari (macOS, iOS) — have been tested.
Expandable components (Select, Autocomplete, ExpandableMenu) require Promise which is not present in IE 11 and requires a Promise polyfill to be included on a page.
Reducing footprint
$3
For a "tree-shaking" bundler (should work, but check it yourself just in case):
`js
import { Modal, Button, TextInput } from 'react-responsive-ui'
`
For "ECMAScript modules" imports:
`js
import Modal from 'react-responsive-ui/modules/Modal'
import Button from 'react-responsive-ui/modules/Button'
import TextInput from 'react-responsive-ui/modules/TextInput'
`
For CommonJS imports:
`js
import Modal from 'react-responsive-ui/commonjs/Modal'
import Button from 'react-responsive-ui/commonjs/Button'
import TextInput from 'react-responsive-ui/commonjs/TextInput'
`
$3
The CSS styles could also be imported selectively (theoretically): instead of importing the whole react-responsive-ui/style.css bundle, one could import just the necessary styles from the react-responsive-ui/styles/ folder. But there's a catch: some components' styles may also require some other styles to be loaded.
For example, the component requires the following stylesheets to be loaded:
* react-responsive-ui/styles/Button.css
* react-responsive-ui/styles/ButtonReset.css
* react-responsive-ui/styles/Input.css
And the component requires the following stylesheets to be loaded (didn't check):
* react-responsive-ui/styles/DatePicker.css
* react-responsive-ui/styles/ButtonReset.css
* react-responsive-ui/styles/Input.css
* react-responsive-ui/styles/TextInput.css
* react-responsive-ui/styles/Expandable.css
* react-responsive-ui/styles/Close.css
And don't forget about also including react-responsive-ui/variables.css when going with the selective styles import approach.
So it might be easier to just import the whole react-responsive-ui/style.css file.
Outline
By default all buttons and inputs have rrui__outline CSS class attached to them which hides the default browser outline for focused components.
`css
.rrui__outline:not(.rrui__outline--default) {
outline: none;
}
`
Instead of using the default browser outline which doesn't look pretty by any standards and which nobody uses (not "Google", not "Apple", not anyone else) the default react-responsive-ui styles define some custom :focus styling for most cases (though not for all of them). Still, these out-of-the-box :focus styles are quite subtle and if a developer is implementing a WAI-ARIA-compliant website then they should make sure that those :focus styles are more pronounced in each case.
Alternatively, those looking for a very-quick-and-dirty solution can use the same default browser outline, but prettier.
`css
.rrui__outline:focus {
box-shadow: 0 0 0 0.15rem #00aaff;
}
`
If a developer still prefers the default browser outline then they still can manually add rrui__outline--default CSS class to buttons and inputs to prevent outline: none CSS rule from being applied.
There's also an exported component called which listens to keydown events on document.body, and when it detects a Tab key being pressed it adds rrui__tabbing CSS class to document.body. Any further mouse or touch events reset the rrui__tabbing CSS class. This way rrui__outline can only be shown when the user is actually tabbing. It's still not considered a 100%-formally-correct solution because "screen readers" still emit all kinds of mouse events, or maybe some "screen readers" hypothetically don't emit a "keydown" event for the Tab key — who knows. It's more of an experimental feature. There're some other possible ideas like ./source/Interaction.js.
Inspecting Expandables
Expandables are implemented in such a way that they collapse when losing focus. This may present difficulties when trying to inspect expandable content via DevTools because switching to DevTools captures focus causing expandables to collapse. For such cases there's a global debug flag window.rruiCollapseOnFocusOut which can be set to false to prevent expandables from collapsing when losing focus. This flag affects: , , , , , , .
Known Issues
An overflown scroll is janky on iOS because it tries to scroll instead of the contents. That's how it is on iOS.
Contributing
After cloning this repo, ensure dependencies are installed by running:
`sh
npm install
`
This module is written in ES6 and uses Babel for ES5
transpilation. Widely consumable JavaScript can be produced by running:
`sh
npm run build
`
Once npm run build has run, you may import or require() directly from
node.
After developing, the full test suite can be evaluated by running:
`sh
npm test
`
When you're ready to test your new functionality on a real project, you can run
`sh
npm pack
`
It will build, test and then create a .tgz archive which you can then install in your project folder
`sh
npm install [module name with version].tar.gz
``