helpful error message when defaultClass props forgotten

franklintarter · Oct 15, 2019 · 8ba2eaa · 8ba2eaa
1 parent 9c81b0a
commit 8ba2eaa
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "tailwindcss-overload",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "tailwindcss-overload",
   "main": "lib/index.js",
   "module": "es/index.js",

diff --git a/src/index.js b/src/index.js
@@ -13,6 +13,11 @@ export const overloadTailwind = (initialClasses, overloadClasses) => {
 
 export const withTailwindOverload = PassedComponent => {
   return ({ className, ...rest }) => {
+    if (!PassedComponent.defaultClassName) {
+      throw new Error(
+        "No defaultClassName found. Components wrapped withTailwindOverload() require defaultClassName property 'MyComponent.defaultClassname = \"text-gray-500\"'"
+      );
+    }
     const overloadedClasses = overloadTailwind(
       PassedComponent.defaultClassName,
       className