feat: initial release

Author: gregberge

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env", "@babel/preset-react"]
+}

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+/dist/

.npmignore

@@ -0,0 +1,4 @@
+/*
+!/dist/**/*.js
+!/src/**/*.js
+*.test.js

.travis.yml

@@ -0,0 +1,19 @@
+language: node_js
+
+node_js:
+  - 10
+
+before_install:
+  - curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version 1.10.1
+  - export PATH="$HOME/.yarn/bin:$PATH"
+
+notifications:
+  email: false
+
+cache:
+  yarn: true
+  directories:
+    - 'node_modules'
+
+git:
+  depth: 5

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2018 Smooth Code
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,62 @@
+# react-flatten-children
+
+[![License](https://img.shields.io/npm/l/react-flatten-children.svg)](https://github.com/smooth-code/react-flatten-children/blob/master/LICENSE)
+[![npm package](https://img.shields.io/npm/v/react-flatten-children/latest.svg)](https://www.npmjs.com/package/react-flatten-children)
+[![Build Status](https://img.shields.io/travis/smooth-code/react-flatten-children.svg)](https://travis-ci.org/smooth-code/react-flatten-children)
+[![Dependencies](https://img.shields.io/david/smooth-code/react-flatten-children.svg?path=packages%2Fcore)](https://david-dm.org/smooth-code/react-flatten-children?path=packages/core)
+[![DevDependencies](https://img.shields.io/david/dev/smooth-code/react-flatten-children.svg)](https://david-dm.org/smooth-code/react-flatten-children?type=dev)
+
+React utility to flatten fragments 🗜.
+
+```sh
+npm install react-flatten-children
+```
+
+## Example
+
+```js
+import React from 'react'
+import { Switch as BaseSwitch } from 'react-router'
+import flattenChildren from 'react-flatten-children'
+import PublicHome from './PublicHome'
+import PrivateHome from './PrivateHome'
+import Account from './Account'
+import Login from './Login'
+
+// Create a fragment ready Switch
+const Switch = ({ children }) => (
+  <BaseSwitch>{flattenChildren(children)}</BaseSwitch>
+)
+
+const Routes = ({ isLoggedIn }) => (
+  <Switch>
+    {isLoggedIn ? (
+      <>
+        <Route exact path="/" component={PrivateHome} />
+        <Route path="/account" component={Account} />
+      </>
+    ) : (
+      <>
+        <Route exact path="/" component={PublicHome} />
+        <Route path="/login" component={Login} />
+      </>
+    )}
+    <Route path="/about" component={About} />
+    <Redirect to="/" />
+  </Switch>
+)
+
+export default Routes
+```
+
+👉 [Checkout an interactive example on CodeSandbox](https://codesandbox.io/s/nn6l3r30k0)
+
+## Why?
+
+In many cases you have to introspect children, it can be to [use the first route matching a path](https://reacttraining.com/react-router/web/api/Switch), extract the label of a tab, or another use case.
+
+React considers fragments as children, even if it is in fact a group of children. This package flatten children and make your component API compatible with fragments. Users expect your library to be compatible with fragments. If you want to avoid tons of issues (see https://github.com/ReactTraining/react-router/issues/5917, https://github.com/ReactTraining/react-router/issues/5785), you should use it!
+
+# License
+
+MIT

package.json

@@ -0,0 +1,32 @@
+{
+  "name": "react-flatten-children",
+  "description": "React utility to flatten fragments.",
+  "keywords": [
+    "react",
+    "utility",
+    "children",
+    "flatten",
+    "fragment"
+  ],
+  "version": "1.0.0",
+  "author": "Greg Bergé <berge.greg@gmail.com>",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "umd:main": "dist/index.umd.js",
+  "module": "dist/index.mjs",
+  "source": "src/index.js",
+  "scripts": {
+    "test": "jest",
+    "build": "microbundle --external react"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.1.2",
+    "@babel/preset-env": "^7.1.0",
+    "@babel/preset-react": "^7.0.0",
+    "babel-core": "^7.0.0-0",
+    "babel-jest": "^23.6.0",
+    "jest": "^23.6.0",
+    "microbundle": "^0.6.0",
+    "react": "^16.5.2"
+  }
+}

src/index.js

@@ -0,0 +1,13 @@
+import React from 'react'
+
+function flattenChildren(children) {
+  return React.Children.toArray(children).reduce((flatChildren, child) => {
+    if (child.type === React.Fragment) {
+      return flatChildren.concat(flattenChildren(child.props.children))
+    }
+    flatChildren.push(child)
+    return flatChildren
+  }, [])
+}
+
+export default flattenChildren

src/index.test.js

@@ -0,0 +1,69 @@
+import React from 'react'
+import flattenChildren from '.'
+
+const getChildren = element => element.props.children
+const getTypes = children => React.Children.map(children, child => child.type)
+
+describe('flattenChildren', () => {
+  it('should convert child to array', () => {
+    const children = getChildren(<>Hello</>)
+    expect(flattenChildren(children)).toEqual(React.Children.toArray(children))
+  })
+
+  it('should convert children to array', () => {
+    const children = getChildren(
+      <>
+        <a />
+        <b />
+      </>,
+    )
+    expect(flattenChildren(children)).toEqual(React.Children.toArray(children))
+  })
+
+  it('should flatten fragments', () => {
+    const input = getChildren(
+      <>
+        <>
+          <a />
+          <b />
+        </>
+        <>
+          <c />
+        </>
+        <d />
+      </>,
+    )
+    expect(getTypes(flattenChildren(input))).toEqual(['a', 'b', 'c', 'd'])
+  })
+
+  it('should flatten nested fragments', () => {
+    const input = getChildren(
+      <>
+        <>
+          <a />
+          <b />
+        </>
+        <>
+          <c />
+          <>
+            <d />
+            <e />
+            <>
+              <f />
+            </>
+          </>
+        </>
+        <g />
+      </>,
+    )
+    expect(getTypes(flattenChildren(input))).toEqual([
+      'a',
+      'b',
+      'c',
+      'd',
+      'e',
+      'f',
+      'g',
+    ])
+  })
+})