v0.7.2

Signed-off-by: Florian BOUILLON <florian.bouillon@delta-wings.net>

.gitignore

@@ -2,7 +2,10 @@ module/
 node_modules/
 *.mjs
 *.js
+!src/dzeio/stylusUtils.js
 *.d.ts
+types/
+!rollup.config.js
 !src/stylus.d.ts
 !.storybook/*.js
 style.css

.npmignore

@@ -4,7 +4,5 @@ node_modules/
 .gitattributes
 .gitignore
 .npmignore
-rollup.config.js
-tsconfig.json
 yarn.lock
 yarn-error.log

.storybook/mockNextRouter.js

@@ -0,0 +1,8 @@
+import Router from 'next/router';
+
+Router.router = {
+	push: async () => {},
+	replace: async () => {},
+	prefetch: () => {},
+	route: '/mock-route',
+	pathname: 'mock-path',};

.storybook/preview.js

@@ -1,4 +1,5 @@
 import '../src/dzeio/general.styl'
+import './mockNextRouter'
 
 export const parameters = {
   layout: 'centered'

package.json

@@ -1,9 +1,9 @@
 {
 	"name": "@dzeio/components",
-	"version": "0.5.0",
+	"version": "0.7.2",
 	"license": "MIT",
-	"main": "./src/index.mjs",
+	"main": "./index.js",
-	"types": "./src/index.d.ts",
+	"types": "./types/index.d.ts",
 	"devDependencies": {
 		"@babel/core": "^7.12.16",
 		"@babel/preset-env": "^7.12.16",
@@ -24,18 +24,27 @@
 		"stylus": "^0.54.8",
 		"stylus-loader": "^4.3.3",
 		"ts-loader": "^8.0.17",
-		"typescript": "^4.1.3",
+		"typescript": "^4.2.3",
 		"webpack": "^4.44.2"
 	},
 	"peerDependencies": {
 		"next": "^10.0.5",
 		"react": "^17.0.1",
 		"react-dom": "^17.0.1",
-		"react-feather": "^2.0.9"
+		"react-feather": "^2.0.9",
+		"stylus": "^0.54.8",
+		"typescript": "^4.2.3"
 	},
 	"scripts": {
-		"storybook": "rm -rf src/dzeio/**/*.js && start-storybook -p 6006",
+		"dev": "rm -rf src/dzeio/**/*.js && start-storybook -p 6006",
-		"build": "tsc && mv src/index.js src/index.mjs",
+		"build": "rollup --config",
-		"prepublishOnly": "yarn build"
+		"prepublishOnly": "yarn build",
+		"postinstall": "rollup --config"
+	},
+	"dependencies": {
+		"rollup": "^2.44.0",
+		"rollup-plugin-styles": "^3.14.1",
+		"rollup-plugin-typescript2": "^0.30.0",
+		"tslib": "^2.1.0"
 	}
 }

rollup.config.js

@@ -0,0 +1,27 @@
+import typescript from 'rollup-plugin-typescript2';
+import styles from 'rollup-plugin-styles'
+import pkg from './package.json';
+
+export default [
+	{
+		input: 'src/index.ts',
+		external: ['ms'],
+		plugins: [
+			styles({
+				modules: true,
+				url: false,
+				autoModules: true,
+				mode: 'extract',
+
+			}),
+			typescript({useTsconfigDeclarationDir: true}), // so Rollup can convert TypeScript to JavaScript
+		],
+		output: [
+			{
+				file: pkg.main,
+				format: 'cjs',
+				assetFileNames: 'style.css'
+			}
+		]
+	}
+];

src/dzeio/Link/Link.module.styl

@@ -1,9 +1,9 @@
 @import '../config'
 
 .link
-	color $infoLight
+	color $infoDark
 	@media (prefers-color-scheme dark)
-		color $infoDark
+		color $infoLight
 	&:hover
 		text-decoration underline
 

src/dzeio/Link/index.tsx

@@ -6,9 +6,15 @@ import css from './Link.module.styl'
 import { buildClassName } from '../Util'
 
 interface Props {
+	linkProps?: React.DetailedHTMLProps<React.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>
 	href: string
 	children?: React.ReactNode
 	className?: string
+	/**
+	 * Remove styling
+	 */
+	noStyle?: boolean
+
 	/**
 	 * Override external detection system
 	 */
@@ -23,7 +29,8 @@ export default class Link extends React.Component<Props> {
 			// external link
 			return (
 				<a
-					className={buildClassName(this.props.className, css.link)}
+					{...this.props.linkProps}
+					className={buildClassName(this.props.className, [css.link, !this.props.noStyle])}
 					href={this.props.href}
 					rel="noreferrer nofollow"
 					target="_blank"
@@ -35,7 +42,8 @@ export default class Link extends React.Component<Props> {
 		return (
 			<NextLink href={this.props.href}>
 				<a
-					className={buildClassName(this.props.className, css.link)}
+					{...this.props.linkProps}
+					className={buildClassName(this.props.className, [css.link, !this.props.noStyle])}
 				>{this.props.children}</a>
 			</NextLink>
 		)

src/dzeio/Navbar/Navbar.module.styl

@@ -1,11 +1,69 @@
 @import '../config'
 
-.body
+// $transition = 10s linear
-	margin-left 300px
+// $transitionTime = 10s
-	transition margin-left $transition
+// $transitionFunction = linear
+.body-sidebar
+		margin-left 300px
+		transition margin-left $transition
+		&.short
+			margin-left 56px
+
+.body-navbar
+		margin-top 70px
+
+.navbar
+	background $foregroundLight
+	@media (prefers-color-scheme dark)
+		background $foregroundDark
+	position fixed
+	left 0
+	top 0
+	height 70px
+	width 100%
+	z-index 100
+	display flex
+	padding 16px
+
+	> ul, .userSpaceParent ul
+		display flex
+
+		li:first-child p
+			margin-left 0
+
+	> ul p, .userSpaceParent > ul p
+		padding 8px
+
+		margin-left 16px
+		border-radius 4px
+
+		&.active
+			background $mainGradient
+			color $textOnMain
+
+	.userSpace
+
+		height 100%
+		display flex
+		align-items center
+		cursor pointer
+		user-select none
+		svg
+			margin-left 16px
+			vertical-align top
+
+	.userMenu
+		position fixed
+		top 70px
+		right 0
+		padding 16px
+		border-bottom-left-radius 4px
+		transform translateX(100%)
+		background inherit
+		transition transform $transition
+		&.menuActive
+			transform translateX(0%)
 
-	&.short
-		margin-left 56px
 
 .sidebar
 	background $foregroundLight
@@ -19,6 +77,11 @@
 	z-index 100
 	display flex
 	flex-direction column
+
+	&.mobile
+		width 100%
+		z-index 101
+
 	&
 		transition width $transition
 	.header
@@ -33,21 +96,42 @@
 	> ul span
 		width calc(100% - 40px)
 		max-width 100%
+	.header p
+		cursor pointer
 
 	.userSpaceParent
 		background $backgroundLight
 		@media (prefers-color-scheme dark)
 			background $backgroundDark
 
+		> ul, .userSpaceParent ul
+				display flex
+				padding 16px
+				justify-content center
+
+				li:first-child p
+					margin-left 0
+
+			> ul p, .userSpaceParent > ul p
+				padding 8px
+
+				margin-left 16px
+				border-radius 4px
+
+				&.active
+					background $mainGradient
+					color $textOnMain
+
 	.userSpace
 		cursor pointer
 		user-select none
 		padding 16px
 		width 100%
 		max-width 100%
-		min-height 56px
+		min-height 86px
 		p
 			overflow hidden
+			white-space nowrap
 		p:last-child:not(:first-child)
 			margin-top 8px
 			font-style italic
@@ -65,11 +149,6 @@
 		max-height 0px
 		transition all $transition
 
-		ul
-			padding-bottom 16px
-			a
-				padding 16px 0
-
 		&.menuActive
 			// TODO find better way to animate this shit
 			max-height 100%
@@ -82,43 +161,73 @@
 		.userSpace
 		> ul span
 			width 0
-			padding 0
+			padding-left 0
+			padding-right 0
 			margin 0
 			max-width 0
 
+
 	.header
 		min-height 70px
-		> div
+		padding 0
-			padding 0
+		margin 0
-			&:first-child
+		> div p > div
-				padding 16px
+		> div:first-child
-		p > div
 			padding 16px
+		> div:last-child
+			padding 0
 
 	hr
 		margin 0
 
-	ul
-		list-style none
-		margin 0
-		padding 0
-
 	> ul li
 			width 100%
 			p
 				padding 16px 0
 				display flex
 				align-items center
-				// TODO Currently Gradient aren't supported by Transition
+				z-index 111
-				// transition-property background-image, color
+				position relative
-				// transition-duration $transitionTime
+
-				// transition-timing-function $transitionFunction
+				// Temporary fix the transition for linear-gradient
+				&::before
+					transition opacity $transition
+					opacity 0
+					width 100%
+					height 100%
+					content " "
+					position absolute
+					z-index -1
+					background-image $mainGradient
 				&:hover
 				&.active
-					background-image $mainGradient
+					color $textOnMain
-					color white
+					&::before
+						opacity 1
 				svg
 					margin-left 16px
 				span
 					padding-left 16px
 					height inherit
+
+.navbar, .sidebar
+	ul
+		list-style none
+		margin 0
+		padding 0
+
+.userMenu
+		// padding-bottom 16px
+		a
+			padding 16px 0
+
+
+.mobileMenu
+	opacity 0
+	transition opacity $transition
+	&.shown
+		opacity 1
+
+.mainGradient
+	//WIP
+	fill $mainGradient

src/dzeio/Navbar/Navbar.stories.tsx

@@ -1,4 +1,4 @@
-import { Meta } from '@storybook/react/types-6-0'
+import { Meta, Story } from '@storybook/react/types-6-0'
 import React from 'react'
 import Component from '.'
 
@@ -7,4 +7,24 @@ export default {
 	component: Component
 } as Meta
 
-export const Basic = (args: any) => <Component {...args} />
+export const Basic: Story<any> = (args: any) => <Component {...args} />
+Basic.args = {
+	items: [{
+		path: '/dashboard',
+		name: 'Dasboard'
+	}],
+	loginUrl: '/login',
+	registerUrl: '/register',
+	type: 'navbar',
+	user: {
+		name: 'Username',
+		description: 'User Description',
+		menu: {
+			links: [{
+				path: '/logout',
+				name: 'Logout'
+			}]
+		}
+	},
+	logo: {src: '/assets/logo.svg', width: 90, height: 38}
+}

src/dzeio/Navbar/index.tsx

@@ -2,7 +2,7 @@ import Router from 'next/router'
 
 import Image, { ImageProps } from 'next/image'
 import React, { FC } from 'react'
-import { ChevronDown, ChevronsRight, X } from 'react-feather'
+import { ChevronDown, ChevronsRight, Menu, X } from 'react-feather'
 import Text from '../Text'
 import Col from '../Col'
 import Row from '../Row'
@@ -12,117 +12,262 @@ import { buildClassName } from '../Util'
 import css from './Navbar.module.styl'
 
 interface Props {
+	/**
+	 * Type of Navbar
+	 * _note: when in mobile it is not listened_
+	 */
 	type: 'navbar' | 'sidebar'
-	logo: ImageProps
+
+	/**
+	 * Logo to display
+	 */
+	logo?: ImageProps & {height: number, width: number}
+	/**
+	 * Login URL
+	 */
+	loginUrl?: string
+	/**
+	 * Login URL
+	 */
+	registerUrl?: string
+	/**
+	 * User Informations if loggedin
+	 */
 	user?: {
+		/**
+		 * Username
+		 */
 		name: string
+		/**
+		 * User Short description
+		 */
 		description?: string
-		settings?: string
+		/**
+		 * User Menu
+		 */
 		menu?: {
+			/**
+			 * Menu links
+			 */
 			links: Array<{
 				path: string
 				name: string
 			}>
+			/**
+			 * Custom informations shown next to the links
+			 */
 			informations?: JSX.Element
 		}
 	}
+	/**
+	 * Links to display
+	 */
 	items: Array<{
 		path: string
-		icon: FC
+		icon?: FC
 		name: string
 	}>
+	/**
+	 * Internal Usem don't use it !
+	 */
+	mobileMenu?: () => void
 }
 
 interface State {
 	path?: string
 	short: boolean
+	isMobile: boolean
 	menuActive: boolean
 }
 
+/**
+ * Navbar/Sidebar Component
+ * @version 1.0.1
+ */
 export default class Navbar extends React.Component<Props, State> {
 
 	public state: State = {
 		short: false,
+		isMobile: false,
 		menuActive: false
 	}
 
 	public componentDidMount() {
-		this.setState({path: Router.asPath})
+		this.setState({
-		Router.events.on('routeChangeComplete', () => {
+			path: Router.asPath,
-			this.setState({path: Router.asPath})
+			menuActive: !!this.props.mobileMenu
 		})
-		document.body.classList.add(css.body)
+		Router.events.on('routeChangeComplete', () => {
-		if (this.state.short) {
+			this.setState({path: Router.asPath, menuActive: false})
-			document.body.classList.add(css.short)
+		})
+		Router.events.on('routeChangeError', () => {
+			this.setState({path: Router.asPath, menuActive: false})
+		})
+		if (!this.props.mobileMenu) {
+			window.addEventListener('resize', this.onResize)
+			this.onResize()
+		}
+	}
+
+	public onResize = () => {
+		const isMobile = window.innerWidth <= 768
+		if (this.state.isMobile !== isMobile) {
+			this.setState({isMobile})
 		}
 	}
 
 	public componentDidUpdate() {
-		if (this.state.short) {
+		if (!this.props.mobileMenu) {
-			document.body.classList.add(css.short)
+			if (this.state.short) {
-		} else {
+				document.body.classList.add(css.short)
-			document.body.classList.remove(css.short)
+			} else {
-
+				document.body.classList.remove(css.short)
+			}
+			if (this.getType() === 'sidebar') {
+				document.body.classList.add(css['body-sidebar'])
+				document.body.classList.remove(css['body-navbar'])
+			} else {
+				document.body.classList.remove(css['body-sidebar'])
+				document.body.classList.add(css['body-navbar'])
+			}
 		}
+
 	}
 
 	public componentWillUnmount() {
-		document.body.classList.remove(css.body, css.short)
+		if (!this.props.mobileMenu) {
+			document.body.classList.remove(css.short, css[`body-${this.getType()}`])
+			window.removeEventListener('resize', this.onResize)
+		}
+	}
+
+	public onSidebarButton = () => {
+		if (!this.props.mobileMenu) {
+			this.setState({short: !this.state.short, menuActive: false})
+		} else {
+			this.props.mobileMenu()
+		}
+	}
+
+	public menuCloseCallback = () => {
+		this.setState({menuActive: false})
+	}
+
+	public getType(): 'sidebar' | 'navbar' {
+		if (this.props.mobileMenu) {
+			return 'sidebar'
+		}
+		return this.state.isMobile ? 'navbar' : this.props.type
 	}
 
 	public render = () => (
-		<nav className={buildClassName(css.sidebar, [css.short, this.state.short])}>
+		<>
-			<Row nomargin className={css.header} align="center">
+			<nav className={buildClassName(css[this.getType()], [css.short, this.state.short && !this.props.mobileMenu], [css.mobile, this.props.mobileMenu])}>
-				<Col className={css.imgContainer}><Link href="/"><Image {...this.props.logo} /></Link></Col>
+				<Row nowrap className={css.header} align="center">
-				<Col nogrow><Text><div onClick={() => this.setState({short: !this.state.short, menuActive: false})}>
+					{this.props.logo && (
-					{this.state.short ? (
+						<Col className={css.imgContainer}>
-						<ChevronsRight size={30} />
+							<Link href="/">
-					) : (
+								<Image {...this.props.logo} height={34} width={this.props.logo.width*34/this.props.logo.height} />
-						<X size={30} />
+							</Link>
+						</Col>
 					)}
-				</div></Text></Col>
+					{this.getType() === 'sidebar' && (
-			</Row>
+						<Col nogrow><Text><div onClick={this.onSidebarButton}>
-			<hr/>
+							{this.state.short ? (
-			<ul>
+								<ChevronsRight size={30} />
-				{this.props.items.map((item) => (
+							) : (
-					<li key={item.path}><Link href={item.path}><a>
+								<X size={30} />
-						<Text className={buildClassName([css.active, this.state.path?.startsWith(item.path)])} >
+							)}
-							<item.icon />
+						</div></Text></Col>
-							<span>{item.name}</span>
+					)}
-						</Text>
+				</Row>
-					</a></Link></li>
+				{this.getType() === 'sidebar' && (
-				))}
+					<hr/>
-			</ul>
+				)}
-			<div style={{flex: 1}}></div>
+				<ul>
-			{/* Spacer */}
+					{!this.state.isMobile && this.props.items.map((item) => (
-			{this.props.user && (
+						<li key={item.path}><Link noStyle href={item.path}><a>
-				<>
+							<Text className={buildClassName([css.active, this.state.path?.startsWith(item.path)])}>
+								{this.getType() === 'sidebar' && item.icon && (
+									<item.icon />
+								)}
+								<span>{item.name}</span>
+							</Text>
+						</a></Link></li>
+					))}
+				</ul>
+				<div style={{flex: 1}}></div>
+				{/* Spacer */}
+				{this.state.isMobile && (
 					<div className={css.userSpaceParent}>
-						<hr/>
 						<div onClick={() => this.setState({menuActive: !this.state.menuActive})} className={css.userSpace}>
 							<Text>
-								{this.props.user.name}
+								<Menu size={38} className={css.mainGradient} />
-								<ChevronDown className={buildClassName([css.menuActive, this.state.menuActive])} />
 							</Text>
-							{this.props.user.description && (
-								<Text>{this.props.user.description}</Text>
-							)}
 						</div>
 					</div>
-					<div className={buildClassName(css.userMenu, [css.menuActive, this.state.menuActive])}>
+				)}
-						<Row nomargin>
+				{!this.state.isMobile && this.props.user ? (
-							<Col></Col>
+					<>
-							<Col>
+						<div className={css.userSpaceParent}>
-								<ul>
+							{this.getType() === 'sidebar' && (
-									{this.props.user.menu?.links.map((l) => (
+								<hr/>
-										<li key={l.path}><Text><Link href={l.path}>{l.name}</Link></Text></li>
+							)}
-									))}
+							<div onClick={() => this.setState({menuActive: !this.state.menuActive})} className={css.userSpace}>
-								</ul>
+								<Text>
-							</Col>
+									{this.props.user.name}
-						</Row>
+									<ChevronDown className={buildClassName([css.menuActive, this.state.menuActive])} />
+								</Text>
+								{this.getType() === 'sidebar' && this.props.user.description && (
+									<Text>{this.props.user.description}</Text>
+								)}
+							</div>
+						</div>
+						<div className={buildClassName(css.userMenu, [css.menuActive, !this.state.isMobile && this.state.menuActive])}>
+							<Row>
+								{this.props.user.menu?.informations && (
+									<Col>{this.props.user.menu?.informations}</Col>
+								)}
+								<Col>
+									<ul>
+										{this.props.user.menu?.links.map((l) => (
+											<li key={l.path}><Text><Link noStyle href={l.path}>{l.name}</Link></Text></li>
+										))}
+									</ul>
+								</Col>
+							</Row>
+						</div>
+					</>
+				) : !this.state.isMobile ? (
+					<div className={css.userSpaceParent}>
+						{this.getType() === 'sidebar' && (
+							<hr/>
+						)}
+						<ul>
+							{this.props.registerUrl && (
+								<li><Link noStyle href={this.props.registerUrl}><a>
+									<Text className={buildClassName(css.active)}>
+										<span>Register</span>
+									</Text>
+								</a></Link></li>
+							)}
+							{this.props.loginUrl && (
+								<li><Link noStyle href={this.props.loginUrl}><a>
+									<Text>
+										<span>Login</span>
+									</Text>
+								</a></Link></li>
+							)}
+						</ul>
 					</div>
-				</>
+				) : undefined}
+			</nav>
+
+			{!this.props.mobileMenu && this.state.isMobile && (
+				<div className={buildClassName(css.mobileMenu, [css.shown, this.state.menuActive])}>
+					<Navbar {...this.props} type="sidebar" mobileMenu={this.menuCloseCallback} />
+				</div>
 			)}
-		</nav>
+		</>
 	)
 }

src/dzeio/SidebarContainer/SidebarContainer.module.styl

@@ -1,32 +0,0 @@
-@import "../config.styl"
-
-.sidebar
-	position fixed
-	width 200px
-	top 0
-	left 0
-	height 100%
-	background white
-	padding 16px
-
-.content
-	padding-left 200px
-
-.item
-	display flex
-	padding 8px 16px
-	margin-top 8px
-	transition $transition
-	border-radius 8px
-
-	svg
-		margin-right 8px
-
-	div
-		text-align center
-		flex-grow 1
-		margin-left -32px
-
-	&:hover
-		background $default
-		color white

src/dzeio/SidebarContainer/index.tsx

@@ -1,45 +0,0 @@
-import React, { FC } from 'react'
-
-import { ChevronLeft, TrendingUp } from 'react-feather'
-import Link from 'next/link'
-import Image from '../Image'
-
-import { IconProps } from '../interfaces'
-import css from './SidebarContainer.module.styl'
-
-interface Props {
-	domain: string
-	children: React.ReactNode
-}
-
-export default class SidebarContainer extends React.Component<Props> {
-
-	private menu: Array<{name: string, icon: FC<IconProps>, href: string, as?: string}> = [
-		{ name: 'back', icon: ChevronLeft, href: '/dashboard' },
-		{ name: 'Uptime', icon: TrendingUp, as: `/dashboard/${this.props.domain}/uptime`, href: '/dashboard/[domain]/uptime' }
-
-	]
-	public render = () => (
-		<>
-			<nav className={css.sidebar}>
-				<Link href="/dashboard">
-					<a>
-						<Image src="/assets/logo.svg" width={175} height={100} />
-					</a>
-				</Link>
-				{this.menu.map((item, index) => (
-					<Link key={index} href={item.href} as={item.as}>
-						<a className={css.item}>
-							<item.icon />
-							<div>{item.name}</div>
-						</a>
-					</Link>
-				))}
-			</nav>
-			<div className={css.content}>
-				{this.props.children}
-			</div>
-		</>
-	)
-
-}

src/dzeio/stylusUtils.js

@@ -0,0 +1,11 @@
+
+// See https://github.com/stylus/stylus/issues/1872#issuecomment-86553717
+var stylus = require('stylus');
+
+module.exports = function() {
+	return function(style) {
+		style.define('file-exists', function(path) {
+		return !!stylus.utils.lookup(path.string, this.paths);
+		});
+	};
+};

src/index.ts

@@ -1,3 +1,9 @@
+/**
+ * Copyright (c) 2021
+ *
+ * @summary DZEIO Component Library
+ */
+
 import Box from './dzeio/Box'
 import Button from './dzeio/Button'
 import Checkbox from './dzeio/Checkbox'
@@ -16,7 +22,6 @@ import Navbar from './dzeio/Navbar'
 import Overflow from './dzeio/Overflow'
 import Popup from './dzeio/Popup'
 import Row from './dzeio/Row'
-import SidebarContainer from './dzeio/SidebarContainer'
 import Table from './dzeio/Table'
 import Text from './dzeio/Text'
 import * as Util from './dzeio/Util'
@@ -40,7 +45,6 @@ export {
 	Overflow,
 	Popup,
 	Row,
-	SidebarContainer,
 	Table,
 	Text,
 	Util

tsconfig.json

@@ -11,13 +11,13 @@
 		// "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
 		// "sourceMap": true,                     /* Generates corresponding '.map' file. */
 		// "outFile": "./",                       /* Concatenate and emit output to single file. */
-		"declarationDir": "src",
+		"declarationDir": "types",
 		// "outDir": "./dist",                        /* Redirect output structure to the directory. */
 		// "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
 		// "composite": true,                     /* Enable project compilation */
 		// "removeComments": true,                /* Do not emit comments to output. */
 		// "noEmit": true,                        /* Do not emit outputs. */
-		// "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+		"importHelpers": false,                 /* Import emit helpers from 'tslib'. */
 		// "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
 		// "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */