[styles] Warn when the first argument is wrong (#11953)

mui · Jun 22, 2018 · 2386655 · 2386655
1 parent d412a85
commit 2386655
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/docs/src/pages/customization/css-in-js/css-in-js.md b/docs/src/pages/customization/css-in-js/css-in-js.md
@@ -248,7 +248,7 @@ For instance, it can be used to defined a `getInitialProps()` static method (nex
 
 #### Arguments
 
-1. `styles` (*Function | Object*): A function generating the styles or an object.
+1. `styles` (*Function | Object*): A function generating the styles or a styles object.
 It will be linked to the component.
 Use the function signature if you need to have access to the theme. It's provided as the first argument.
 2. `options` (*Object* [optional]):

diff --git a/packages/material-ui/src/styles/getStylesCreator.js b/packages/material-ui/src/styles/getStylesCreator.js
@@ -9,6 +9,14 @@ function arrayMerge(destination, source) {
 function getStylesCreator(stylesOrCreator) {
   const themingEnabled = typeof stylesOrCreator === 'function';
 
+  warning(
+    typeof stylesOrCreator === 'object' || themingEnabled,
+    [
+      'Material-UI: the first argument provided to withStyles() is invalid.',
+      'You need to provide a function generating the styles or a styles object.',
+    ].join('\n'),
+  );
+
   function create(theme, name) {
     const styles = themingEnabled ? stylesOrCreator(theme) : stylesOrCreator;