Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(elements): split ui-patterns into lib and playground package #1116

Merged
merged 4 commits into from
Dec 5, 2023
Merged

feat(elements): split ui-patterns into lib and playground package #1116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1550d1a
feat: Split ui-patterns into lib and playground package
TobiasHeimGalindo Nov 30, 2023
1c6f87c
chore: format:fix
TobiasHeimGalindo Nov 30, 2023
106f757
refactor: add elements-react import
TobiasHeimGalindo Dec 5, 2023
7f3887f
Merge branch 'master' into elements-#1100-separate-patterns-and-app
TobiasHeimGalindo Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"start:vue-example:only": "nx run elements-vue-example:start",
"start:landingpage": "nx run-many --target=start --projects=landingpage,elements-react,elements --output-style=stream",
"start:landingpage:only": "nx run landingpage:start",
"start:ui-patterns": "nx run ui-patterns:dev",
"start:ui-patterns-playground": "nx run ui-patterns-playground:start",
"---build---": "",
"build": "nx run-many --target=build --output-style=stream",
"build:core": "nx run elements:build",
Expand All @@ -30,6 +30,7 @@
"build:vue-example": "nx run elements-vue-example:build",
"build:landingpage": "nx run landingpage:build",
"build:ui-patterns": "nx run ui-patterns:build",
"build:ui-patterns-playground": "nx run ui-patterns-playground:build",
"---test---": "",
"test": "nx run-many --target=test --output-style=stream --configuration=ci",
"test:core": "nx run elements:test",
Expand All @@ -43,6 +44,7 @@
"lint:react": "nx run elements-react:lint",
"lint:vue": "nx run elements-vue:lint",
"lint:ui-patterns": "nx run ui-patterns:lint",
"lint:ui-patterns-playground": "nx run ui-patterns-playground:lint",
"format": "yarn prettier --check **/*.{js,ts,tsx,md,html,css,scss}",
"format:fix": "yarn prettier --write ./**/*.{js,ts,tsx,md,html,css,scss}",
"---misc---": "",
Expand Down
18 changes: 18 additions & 0 deletions packages/ui-patterns-playground/.eslintrc.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
module.exports = {
root: true,
env: { browser: true, es2020: true },
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'plugin:react-hooks/recommended',
],
ignorePatterns: ['dist', '.eslintrc.cjs'],
parser: '@typescript-eslint/parser',
plugins: ['react-refresh'],
rules: {
'react-refresh/only-export-components': [
'warn',
{ allowConstantExport: true },
],
},
}
24 changes: 24 additions & 0 deletions packages/ui-patterns-playground/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
3 changes: 3 additions & 0 deletions packages/ui-patterns-playground/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# @inovex.de/ui-patterns-playground

This package serves as a testing and demonstration environment for the UI patterns using the inovex Elements web components styled with Tailwind CSS.
6 changes: 4 additions & 2 deletions packages/ui-patterns/index.html → packages/ui-patterns-playground/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png" />
<link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vite + React + TS</title>
<title>Inovex Elements Patterns</title>
</head>

<body>
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
Expand Down
23 changes: 23 additions & 0 deletions packages/ui-patterns-playground/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"name": "ui-patterns-playground",
"private": true,
"version": "8.1.3",
"type": "module",
"dependencies": {
"react": "^18.2.0",
"react-dom": "^18.2.0",
"@inovex.de/ui-patterns": "8.1.3"
},
"devDependencies": {
"@types/react": "^18.2.37",
"@types/react-dom": "^18.2.15",
"@typescript-eslint/eslint-plugin": "^6.10.0",
"@typescript-eslint/parser": "^6.10.0",
"@vitejs/plugin-react": "^4.2.0",
"eslint": "^8.53.0",
"eslint-plugin-react-hooks": "^4.6.0",
"eslint-plugin-react-refresh": "^0.4.4",
"typescript": "^5.2.2",
"vite": "^5.0.0"
}
}
56 changes: 56 additions & 0 deletions packages/ui-patterns-playground/project.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
{
"name": "ui-patterns-playground",
"projectType": "application",
"sourceRoot": "packages/ui-patterns-playground/src",
"tags": [],
"targets": {
"build": {
"executor": "nx:run-commands",
"outputs": ["{projectRoot}/dist"],
"options": {
"cwd": "packages/ui-patterns-playground",
"commands": ["vite build"]
}
},
"start": {
"executor": "nx:run-commands",
"options": {
"cwd": "packages/ui-patterns-playground"
},
"defaultConfiguration": "dev",
"configurations": {
"dev": {
"command": "vite --port 4500"
},
"prod": {
"command": "vite preview --port 4500"
}
}
},
"lint": {
"executor": "nx:run-commands",
"options": {
"cwd": "packages/ui-patterns-playground",
"command": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0"
},
"configurations": {
"fix": {
"command": "eslint . --ext ts,tsx --fix --report-unused-disable-directives --max-warnings 0"
}
}
},
"clean": {
"executor": "nx:run-commands",
"options": {
"cwd": "packages/ui-patterns-playground",
"command": "shx rm -rf dist"
},
"configurations": {
"nodejs": {
"command": "shx rm -rf node_modules"
}
}
}
}
}

Binary file added packages/ui-patterns-playground/public/favicon-16x16.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/ui-patterns-playground/public/favicon-32x32.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file added packages/ui-patterns-playground/src/App.css
View file
Open in desktop
Empty file.
13 changes: 13 additions & 0 deletions packages/ui-patterns-playground/src/App.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import './App.css';
import { MyPatternA } from '@inovex.de/ui-patterns';
import '@inovex.de/elements-react';

function App() {
return (
<>
<MyPatternA />
</>
);
}

export default App;
1 change: 1 addition & 0 deletions packages/ui-patterns-playground/src/index.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@import '@inovex.de/ui-patterns/dist/style.css';
4 changes: 2 additions & 2 deletions packages/ui-patterns/src/main.tsx → packages/ui-patterns-playground/src/main.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import React from 'react';
import ReactDOM from 'react-dom/client';
import App from './App';
import App from './App.tsx';
import './index.css';

ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render(
ReactDOM.createRoot(document.getElementById('root')!).render(
<React.StrictMode>
<App />
</React.StrictMode>,
Expand Down
1 change: 1 addition & 0 deletions packages/ui-patterns-playground/src/vite-env.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/// <reference types="vite/client" />
26 changes: 26 additions & 0 deletions packages/ui-patterns-playground/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"compilerOptions": {
"target": "ES2020",
"useDefineForClassFields": true,
"lib": ["ES2020", "DOM", "DOM.Iterable"],
"module": "ESNext",
"skipLibCheck": true,

/* Bundler mode */
"moduleResolution": "node",
"allowImportingTsExtensions": true,
"allowSyntheticDefaultImports": true,
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"jsx": "react-jsx",

/* Linting */
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true
},
"include": ["src"],
"references": [{ "path": "./tsconfig.node.json" }]
}
10 changes: 10 additions & 0 deletions packages/ui-patterns-playground/tsconfig.node.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"compilerOptions": {
"composite": true,
"skipLibCheck": true,
"module": "ESNext",
"moduleResolution": "bundler",
"allowSyntheticDefaultImports": true
},
"include": ["vite.config.ts"]
}
7 changes: 7 additions & 0 deletions packages/ui-patterns-playground/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';

// https://vitejs.dev/config/
export default defineConfig({
plugins: [react()],
});
1 change: 1 addition & 0 deletions packages/ui-patterns/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,5 +88,6 @@ To begin contributing a new UI pattern:
// ...
};
```
6. Additionally, import the pattern in the `ui-patterns-playground` package. This allows to showcase the pattern in the playground and test it in a development environment.

Done! Your contribution is now live, both in dev mode and once deployed on our official landing page. It's ready to be viewed and copied on the library patterns page, showcasing the potential of our inovex Elements library. **Thanks for contributing and enriching our library with your UI Pattern!**
82 changes: 32 additions & 50 deletions packages/ui-patterns/project.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,58 +1,40 @@
{
"name": "ui-patterns",
"projectType": "application",
"sourceRoot": "packages/ui-patterns/src",
"tags": [],
"targets": {
"build": {
"executor": "nx:run-commands",
"outputs": ["{projectRoot}/dist"],
"options": {
"cwd": "packages/ui-patterns",
"commands": [
"tsc",
"vite build"
]
}
},
"dev": {
"executor": "nx:run-commands",
"options": {
"cwd": "packages/ui-patterns"
},
"defaultConfiguration": "dev",
"configurations": {
"dev": {
"command": "vite --port 4400"
},
"prod": {
"command": "vite preview --port 4400"
}
}
"name": "ui-patterns",
"projectType": "library",
"sourceRoot": "packages/ui-patterns/src",
"tags": [],
"targets": {
"build": {
"executor": "nx:run-commands",
"outputs": ["{projectRoot}/dist"],
"options": {
"cwd": "packages/ui-patterns",
"commands": ["tsc", "vite build"]
}
},
"lint": {
"executor": "nx:run-commands",
"options": {
"cwd": "packages/ui-patterns",
"command": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0"
},
"lint": {
"executor": "nx:run-commands",
"options": {
"cwd": "packages/ui-patterns",
"command": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0"
},
"configurations": {
"fix": {
"command": "eslint . --ext ts,tsx --fix --report-unused-disable-directives --max-warnings 0"
}
"configurations": {
"fix": {
"command": "eslint . --ext ts,tsx --fix --report-unused-disable-directives --max-warnings 0"
}
}
},
"clean": {
"executor": "nx:run-commands",
"options": {
"cwd": "packages/ui-patterns",
"command": "shx rm -rf dist"
},
"clean": {
"executor": "nx:run-commands",
"options": {
"cwd": "packages/ui-patterns",
"command": "shx rm -rf dist"
},
"configurations": {
"nodejs": {
"command": "shx rm -rf node_modules"
}
"configurations": {
"nodejs": {
"command": "shx rm -rf node_modules"
}
}
}
}
}
1 change: 0 additions & 1 deletion packages/ui-patterns/src/App.css
View file
Open in desktop

This file was deleted.

13 changes: 0 additions & 13 deletions packages/ui-patterns/src/App.tsx
View file
Open in desktop

This file was deleted.

Loading