Merge d575668 into 3c496f8

unform · Mar 12, 2021 · 65c2aef · 65c2aef
2 parents 3c496f8 + d575668
commit 65c2aef
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 210 deletions.
diff --git a/docs/config/sidebar.yml b/docs/config/sidebar.yml
@@ -55,10 +55,6 @@
   items:
     - label: 'File input'
       link: '/examples/file-input'
-    - label: 'Checkbox'
-      link: '/examples/checkbox'
-    - label: 'Radio'
-      link: '/examples/radio'
     - label: 'React Select'
       link: '/examples/react-select'
     - label: 'React DatePicker'
@@ -73,6 +69,8 @@
       link: '/examples/react-native-input-mask'
     - label: 'React Native Picker Select'
       link: '/examples/react-native-picker-select'
+    - label: 'More Examples'
+      link: '/examples/more-examples'
 
 - label: More
   items:

diff --git a/docs/src/docs/examples/checkbox.mdx b/docs/src/docs/examples/checkbox.mdx
diff --git a/docs/src/docs/examples/more-examples.mdx b/docs/src/docs/examples/more-examples.mdx
@@ -0,0 +1,5 @@
+---
+title: More Examples
+---
+
+You can find additional examples in the [examples folder of the Unform repository](https://github.com/unform/unform/tree/develop/examples).
diff --git a/docs/src/docs/examples/radio.mdx b/docs/src/docs/examples/radio.mdx
diff --git a/docs/vercel.json b/docs/vercel.json
@@ -0,0 +1,14 @@
+{
+  "redirects": [
+    {
+      "source": "/examples/checkbox",
+      "destination": "https://github.com/unform/unform/blob/develop/examples/checkbox.js",
+      "permanent": true
+    },
+    {
+      "source": "/examples/radio",
+      "destination": "https://github.com/unform/unform/blob/develop/examples/radio.js",
+      "permanent": true
+    }
+  ]
+}
diff --git a/examples/README.md b/examples/README.md
@@ -10,3 +10,10 @@ needs, hiding labels, styling error messages, etc.
 | Radio    | [JavaScript](./radio.js) - [TypeScript](./typescript/radio.tsx)       |
 | Textarea | [JavaScript](./textarea.js) - [TypeScript](./typescript/textarea.tsx) |
 | Checkbox | [JavaScript](./checkbox.js) - [TypeScript](./typescript/checkbox.tsx) |
+
+## Add an example
+
+If you'd like to submit an example, make sure it hasn't been proposed yet. To get started,
+create your new example on [CodeSandbox](https://codesandbox.io/), test it and make sure it works as expected. When it's ready, open a PR to add it on this folder (we recommend you create the example for both JavaScript and TypeScript, but that's not required).
+
+Also, don't forget to add a Usage example and the component on the file. So it's super easy to test it out! If it's a React Native example, add an `rn-` prefix to it.