Skip to content

Commit

Permalink
feat: build breadcrumbs component
Browse files Browse the repository at this point in the history
  • Loading branch information
gravitano committed Apr 4, 2022
1 parent 76d9385 commit ef4732d
Show file tree
Hide file tree
Showing 9 changed files with 140 additions and 8 deletions.
8 changes: 4 additions & 4 deletions packages/badge/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@
"vitest": "^0.7.10",
"@vue/test-utils": "^2.0.0-rc.17"
},
"main": "dist/app-bar.umd.js",
"unpkg": "dist/app-bar.iife.js",
"jsdelivr": "dist/app-bar.iife.js",
"module": "./dist/app-bar.es.js",
"main": "dist/badge.umd.js",
"unpkg": "dist/badge.iife.js",
"jsdelivr": "dist/badge.iife.js",
"module": "./dist/badge.es.js",
"types": "./dist/types/index.d.ts"
}
46 changes: 46 additions & 0 deletions packages/breadcrumbs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# GITS Breadcrumbs Component

> Reusable Breadcrumbs Component
## Installation

npm

```
npm i @gits-id/breadcrumbs
```

yarn

```
yarn add @gits-id/breadcrumbs
```

pnpm

```
pnpm i @gits-id/breadcrumbs
```

## Usage

```vue
<script setup lang="ts">
// import styles
import '@gits-id/breadcrumbs/dist/style.css';
// import component
import Breadcrumbs from '@gits-id/breadcrumbs';
</script>
<template>
<Breadcrumbs color="primary">Text</Breadcrumbs>
</template>
```

## Documentation

View `Breadcrumbs` documentation [here](https://gits-ui.web.app/?path=/story/components-breadcrumbs--default).

## Licence

ISC
16 changes: 12 additions & 4 deletions packages/breadcrumbs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
"name": "@gits-id/breadcrumbs",
"version": "0.1.17-next.0",
"description": "GITS Breadcrumbs Component",
"main": "src/index.ts",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
"build": "vite build && tsc --emitDeclarationOnly && mv dist/src dist/types",
"prepublishOnly": "npm run build",
"test": "vitest"
},
"keywords": [
"breadcrumbs",
Expand All @@ -15,6 +16,13 @@
"license": "ISC",
"devDependencies": {
"@gits-id/utils": "^0.1.17-next.0",
"tailwindcss": "^3.0.23"
}
"tailwindcss": "^3.0.23",
"vitest": "^0.7.10",
"@vue/test-utils": "^2.0.0-rc.17"
},
"main": "dist/breadcrumbs.umd.js",
"unpkg": "dist/breadcrumbs.iife.js",
"jsdelivr": "dist/breadcrumbs.iife.js",
"module": "./dist/breadcrumbs.es.js",
"types": "./dist/types/index.d.ts"
}
6 changes: 6 additions & 0 deletions packages/breadcrumbs/postcss.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
module.exports = {
plugins: {
tailwindcss: {},
autoprefixer: {},
},
}
5 changes: 5 additions & 0 deletions packages/breadcrumbs/src/vue.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
declare module '*.vue' {
import type {DefineComponent} from 'vue';
const component: DefineComponent<{}, {}, any>;
export default component;
}
6 changes: 6 additions & 0 deletions packages/breadcrumbs/tailwind.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
module.exports = {
content: [
'./src/**/*.{vue,js,ts,jsx,tsx}',
],
presets: [require('@gits-id/tailwind-config/preset')],
};
21 changes: 21 additions & 0 deletions packages/breadcrumbs/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"compilerOptions": {
"baseUrl": ".",
"outDir": "dist",
"declaration": true,
"sourceMap": false,
"target": "esnext",
"module": "esnext",
"moduleResolution": "node",
"allowJs": true,
"strict": true,
"noUnusedLocals": true,
"rootDir": ".",
"skipLibCheck": true,
"types": ["vite/client"],
"emitDeclarationOnly": true,
"allowSyntheticDefaultImports": true
},
"include": ["vue.d.ts", "*.vue", "src"],
"exclude": ["**/*.stories.ts", "**/*.spec.ts", "**/*.test.ts"]
}
36 changes: 36 additions & 0 deletions packages/breadcrumbs/vite.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import {defineConfig} from 'vite';
import vue from '@vitejs/plugin-vue';
import {resolve} from 'path';

// https://vitejs.dev/config/
export default defineConfig({
plugins: [
vue(),
],
esbuild: {
exclude: ['./src/**/**.stories.ts'],
},
build: {
target: 'esnext',
lib: {
entry: resolve(__dirname, 'src/index.ts'),
name: 'Badge',
formats: ['es', 'cjs', 'iife', 'umd'],
},
rollupOptions: {
// make sure to externalize deps that shouldn't be bundled
// into your library
external: ['vue', '@heroicons/vue/outline'],
output: {
// Provide global variables to use in the UMD build
// for externalized deps
globals: {
vue: 'Vue'
}
},
resolve: {
dedupe: "vue"
},
},
},
});
4 changes: 4 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ef4732d

Please sign in to comment.