Skip to content

Commit df4a4ca

Browse files
Xeyos88Xeyos88
committed
Merge branch 'release/1.0.0'
2 parents e25b86c + b383ae8 commit df4a4ca

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+4539
-656
lines changed

‎.github/workflows/deploy.yml

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Sample workflow for building and deploying a VitePress site to GitHub Pages
2+
#
3+
name: Deploy VitePress site to Pages
4+
5+
on:
6+
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
7+
# using the `master` branch as the default branch.
8+
release:
9+
types: [created]
10+
push:
11+
branches: [main]
12+
13+
# Allows you to run this workflow manually from the Actions tab
14+
workflow_dispatch:
15+
16+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
17+
permissions:
18+
contents: read
19+
pages: write
20+
id-token: write
21+
22+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
23+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
24+
concurrency:
25+
group: pages
26+
cancel-in-progress: false
27+
28+
jobs:
29+
# Build job
30+
build:
31+
runs-on: ubuntu-latest
32+
steps:
33+
- name: Checkout
34+
uses: actions/checkout@v4
35+
with:
36+
fetch-depth: 0 # Not needed if lastUpdated is not enabled
37+
# - uses: pnpm/action-setup@v3 # Uncomment this if you're using pnpm
38+
# - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
39+
- name: Setup Node
40+
uses: actions/setup-node@v4
41+
with:
42+
node-version: 20
43+
registry-url: "https://registry.npmjs.org"
44+
cache: npm # or pnpm / yarn
45+
- name: Setup Pages
46+
uses: actions/configure-pages@v4
47+
- name: Install dependencies
48+
run: npm ci # or pnpm install / yarn install / bun install
49+
- name: Build package
50+
run: npm run build
51+
- name: Publish to NPM
52+
if: github.event_name == 'release'
53+
run: npm publish
54+
env:
55+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
56+
- name: Build with VitePress
57+
run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
58+
- name: Upload artifact
59+
uses: actions/upload-pages-artifact@v3
60+
with:
61+
path: docs/.vitepress/dist
62+
63+
# Deployment job
64+
deploy:
65+
environment:
66+
name: github-pages
67+
url: ${{ steps.deployment.outputs.page_url }}
68+
needs: build
69+
runs-on: ubuntu-latest
70+
name: Deploy
71+
steps:
72+
- name: Deploy to GitHub Pages
73+
id: deployment
74+
uses: actions/deploy-pages@v4

‎.gitignore

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,5 @@ docs/.vitepress/dist
3131
*.tgz
3232

3333
#temporary
34-
docs
3534
hy-vue-gantt-1.0.0.tgz
36-
deploy.sh
37-
docs-deploy.yml
35+

‎.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs

‎README.md

Lines changed: 63 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,64 @@
1-
# Hy Vue Gantt
1+
# Hyper Vue Gantt
22

3-
<b>Hyper Vue Gantt</b> is a s fork and update of Vue Ganttastic
3+
A powerful Gantt chart component for Vue 3, evolved from vue-ganttastic. Provides flexible and performant timeline visualization for modern applications.
4+
5+
## 🚀 Installation
6+
7+
```bash
8+
# npm
9+
npm install hy-vue-gantt
10+
11+
# yarn
12+
yarn add hy-vue-gantt
13+
14+
# pnpm
15+
pnpm add hy-vue-gantt
16+
```
17+
18+
### Register Component
19+
20+
```typescript
21+
// main.ts
22+
import { createApp } from "vue"
23+
import App from "./App.vue"
24+
import hyvuegantt from "hy-vue-gantt"
25+
26+
const app = createApp(App)
27+
app.use(hyvuegantt)
28+
app.mount("#app")
29+
```
30+
31+
## 💡 Basic Example
32+
33+
```vue
34+
<template>
35+
<g-gantt-chart
36+
:chart-start="chartStart"
37+
:chart-end="chartEnd"
38+
:precision="precision"
39+
:bar-start="barStart"
40+
:bar-end="barEnd"
41+
>
42+
<g-gantt-row
43+
v-for="row in rows"
44+
:key="row.label"
45+
:label="row.label"
46+
:bars="row.bars"
47+
/>
48+
</g-gantt-chart>
49+
</template>
50+
```
51+
52+
## ✨ Key Features
53+
54+
- 📅 **Flexible Time Units**: Support for hours, days, weeks, and months
55+
- 🎨 **Customizable**: Multiple built-in color schemes and styling options
56+
- 🔗 **Bar Connections**: Visual connections with different styles and animations
57+
- 📱 **Responsive**: Adapts to different screen sizes
58+
- ⌨️ **Keyboard Navigation**: Full keyboard support for accessibility
59+
- 🎯 **Drag & Drop**: Intuitive interface for timeline management
60+
- 🚀 **TypeScript**: Full TypeScript support with predefined types
61+
62+
## 📝 License
63+
64+
MIT

‎deploy.sh

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
set -e
2+
3+
npm run docs:build
4+
cd docs/.vuepress/dist
5+
6+
git init
7+
git add -A
8+
git commit -m 'deploy'
9+
10+
git push -f [email protected]:Xeyos88/HyVueGantt.git master:gh-pages
11+
12+
cd -

‎docs-deploy.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Sample workflow for building and deploying a VitePress site to GitHub Pages
2+
#
3+
name: Deploy VitePress site to Pages
4+
5+
on:
6+
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
7+
# using the `master` branch as the default branch.
8+
push:
9+
branches: [master]
10+
11+
# Allows you to run this workflow manually from the Actions tab
12+
workflow_dispatch:
13+
14+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
20+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
21+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
22+
concurrency:
23+
group: pages
24+
cancel-in-progress: false
25+
26+
jobs:
27+
# Build job
28+
build:
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v3
33+
with:
34+
fetch-depth: 0 # Not needed if lastUpdated is not enabled
35+
# - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
36+
- name: Setup Node
37+
uses: actions/setup-node@v3
38+
with:
39+
node-version: 20
40+
cache: npm # or pnpm / yarn
41+
- name: Setup Pages
42+
uses: actions/configure-pages@v3
43+
- name: Install dependencies
44+
run: npm ci # or pnpm install / yarn install
45+
- name: Build with VitePress
46+
run: npm run docs:build # or pnpm docs:build / yarn docs:build
47+
- name: Upload artifact
48+
uses: actions/upload-pages-artifact@v2
49+
with:
50+
path: docs/.vitepress/dist
51+
52+
# Deployment job
53+
deploy:
54+
environment:
55+
name: github-pages
56+
url: ${{ steps.deployment.outputs.page_url }}
57+
needs: build
58+
runs-on: ubuntu-latest
59+
name: Deploy
60+
steps:
61+
- name: Deploy to GitHub Pages
62+
id: deployment
63+
uses: actions/deploy-pages@v2

‎docs/.vitepress/config.ts

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
import { defineConfig } from "vitepress"
2+
3+
export default defineConfig({
4+
vue: {
5+
template: {
6+
compilerOptions: {
7+
isCustomElement: (tag) => tag.includes('hy-vue-')
8+
}
9+
}
10+
},
11+
lang: 'en-US',
12+
title: "Hyper Vue Gantt",
13+
description: "Documentation for the Huper Vue Gantt Chart Library",
14+
base: '/hy-vue-gantt/',
15+
head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
16+
17+
themeConfig: {
18+
logo: {
19+
src: '/logo.png',
20+
alt: 'Hyper Vue Gantt Logo'
21+
},
22+
23+
nav: [
24+
{ text: "Home", link: "/" },
25+
{
26+
text: "Links",
27+
items: [
28+
{ text: "GitHub", link: "https://github.com/Xeyos88/HyVueGantt" },
29+
{ text: "NPM", link: "https://www.npmjs.com/package/hy-vue-gantt" }
30+
]
31+
}
32+
],
33+
34+
sidebar: {
35+
"/": [
36+
{
37+
text: "Getting Started",
38+
items: [
39+
{ text: "Introduction", link: "/guide/introduction" },
40+
{ text: "Installation", link: "/guide/installation" },
41+
{ text: "Quick Start", link: "/guide/quick-start" }
42+
]
43+
},
44+
{
45+
text: "Core Concepts",
46+
items: [
47+
{ text: "Chart Configuration", link: "/guide/chart-configuration" },
48+
{ text: "Time Axis", link: "/guide/time-axis" },
49+
{ text: "Connections", link: "/guide/connections" },
50+
{ text: "Styling", link: "/guide/styling" }
51+
]
52+
},
53+
{
54+
text: "Components",
55+
items: [
56+
{ text: "GGanttChart", link: "/components/g-gantt-chart" },
57+
{ text: "GGanttRow", link: "/components/g-gantt-row" }
58+
]
59+
},
60+
{
61+
text: "API Reference",
62+
items: [
63+
{ text: "Props", link: "/api/props" },
64+
{ text: "Events", link: "/api/events" },
65+
{ text: "Types", link: "/api/types" },
66+
{ text: "Color Schemes", link: "/api/color-schemes" }
67+
]
68+
},
69+
{
70+
text: "Examples",
71+
items: [
72+
{ text: "Basic Usage", link: "/examples/basic" },
73+
{ text: "Custom Styling", link: "/examples/styling" },
74+
{ text: "Bar Connections", link: "/examples/connections" },
75+
{ text: "Time Management", link: "/examples/time" },
76+
{ text: "Advanced Features", link: "/examples/advanced" },
77+
{ text: "Live Demo", link: "/examples/live" }
78+
79+
]
80+
}
81+
],
82+
},
83+
84+
socialLinks: [{ icon: "github", link: "https://github.com/Xeyos88/HyVueGantt" }],
85+
86+
footer: {
87+
message: "Released under the MIT License.",
88+
copyright: "Copyright © 2024"
89+
}
90+
}
91+
})

‎docs/.vitepress/public/favicon.ico

15 KB
Binary file not shown.

‎docs/.vitepress/public/logo.png

330 KB
Loading

0 commit comments

Comments
 (0)