@inriver/inri 1.17.0 → 1.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.changeset/config.json +1 -1
- package/.changeset/small-cars-pull.md +5 -0
- package/CHANGELOG.md +7 -0
- package/README.md +71 -0
- package/configs/base-tailwind-config.js +1 -1
- package/index.ts +1 -1
- package/package.json +4 -5
- package/src/init/initInriFramework.ts +0 -2
- package/src/styles/tailwind/index.css +0 -3
package/.changeset/config.json
CHANGED
package/CHANGELOG.md
ADDED
package/README.md
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# Inri framework
|
|
2
|
+
|
|
3
|
+
In order to use the *inri* package properly, you need to have certain peer dependencies installed in your project. These peer dependencies are not automatically installed when you install inri, so you have to install them separately.
|
|
4
|
+
|
|
5
|
+
## Peer dependencies
|
|
6
|
+
|
|
7
|
+
Before installing and using *inri*, please make sure you have the following peer dependencies installed in your project:
|
|
8
|
+
|
|
9
|
+
* quasar version 2.12.1 or compatible
|
|
10
|
+
* vue version 3.x.x or any compatible version starting with 3
|
|
11
|
+
* vue-i18n version 9.1.7 or any compatible version starting with 9.1
|
|
12
|
+
* vue-router version 4.0.12 or any compatible version starting with 4
|
|
13
|
+
* WindiCSS - Follow this guide how to set it up https://windicss.org/integrations/
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
pnpm install @inriver/inri
|
|
19
|
+
pnpm install quasar@2.12.1 vue@^3.3.4 vue-i18n@^9.1.7 vue-router@^4.0.12
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
main.ts (entry file)
|
|
25
|
+
```
|
|
26
|
+
import 'virtual:windi.css';
|
|
27
|
+
import { createApp } from 'vue';
|
|
28
|
+
import App from './App.vue';
|
|
29
|
+
|
|
30
|
+
import { initInriFramework } from '@inriver/inri';
|
|
31
|
+
const app = createApp(App);
|
|
32
|
+
app.use(initInriFramework);
|
|
33
|
+
|
|
34
|
+
app.mount('#app');
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
App.vue
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
import { useInriApp } from '@inriver/inri';
|
|
41
|
+
....
|
|
42
|
+
useInriApp()
|
|
43
|
+
```
|
|
44
|
+
CSS
|
|
45
|
+
|
|
46
|
+
Create a tailwind.config.js file and copy this
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
import baseConfig from '@inriver/inri/configs/base-tailwind-config'
|
|
50
|
+
|
|
51
|
+
export default {
|
|
52
|
+
...baseConfig,
|
|
53
|
+
extract: {
|
|
54
|
+
include: [
|
|
55
|
+
'../inri/src/**/*.{vue,html,jsx,tsx}',
|
|
56
|
+
'src/**/*.{vue,html,jsx,tsx}',
|
|
57
|
+
],
|
|
58
|
+
},
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
### Using changesets
|
|
63
|
+
|
|
64
|
+
When it's time to publish a PR follow these steps using changesets CLI
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
1. Run pnpm changeset and follow the prompt
|
|
68
|
+
2. When all is well and one and it's time to release run
|
|
69
|
+
pnpm changeset version which will automatically bump the package.json
|
|
70
|
+
3. Publish command is handled in the release pipeline when merged to main
|
|
71
|
+
```
|
package/index.ts
CHANGED
|
@@ -10,7 +10,7 @@ import { useDoubleClickListener } from './src/composables/useDoubleClickListener
|
|
|
10
10
|
import { useDirtyCheck } from './src/composables/useDirtyCheck'
|
|
11
11
|
import { useTruncateChips } from './src/composables/useTruncateChips'
|
|
12
12
|
import { initInriIcons } from './src/plugins/inriIcons'
|
|
13
|
-
import baseTailwindConfig
|
|
13
|
+
import { baseTailwindConfig } from './configs/base-tailwind-config'
|
|
14
14
|
|
|
15
15
|
export {
|
|
16
16
|
useInriStore,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@inriver/inri",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.18.0",
|
|
4
4
|
"peerDependencies": {
|
|
5
5
|
"quasar": "2.12.1",
|
|
6
6
|
"vue": "^3.3.4",
|
|
@@ -30,7 +30,8 @@
|
|
|
30
30
|
"stylelint": "^13.13.1",
|
|
31
31
|
"stylelint-config-standard": "^22.0.0",
|
|
32
32
|
"stylelint-webpack-plugin": "^3.0.1",
|
|
33
|
-
"typescript": "~4.1.5"
|
|
33
|
+
"typescript": "~4.1.5",
|
|
34
|
+
"@changesets/cli": "^2.26.2"
|
|
34
35
|
},
|
|
35
36
|
"gitHooks": {
|
|
36
37
|
"pre-commit": "lint-staged"
|
|
@@ -45,12 +46,10 @@
|
|
|
45
46
|
"git add"
|
|
46
47
|
]
|
|
47
48
|
},
|
|
48
|
-
"dependencies": {
|
|
49
|
-
"@changesets/cli": "^2.26.2"
|
|
50
|
-
},
|
|
51
49
|
"scripts": {
|
|
52
50
|
"lint": "vue-cli-service lint",
|
|
53
51
|
"changeset": "changeset",
|
|
52
|
+
"version": "changeset version",
|
|
54
53
|
"release": "changeset publish"
|
|
55
54
|
}
|
|
56
55
|
}
|