@paris-ias/list 1.0.2

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.
Files changed (2) hide show
  1. package/README.md +64 -0
  2. package/package.json +49 -0
package/README.md ADDED
@@ -0,0 +1,64 @@
1
+ # @paris-ias/list
2
+
3
+ A Nuxt module for managing list components with GraphQL integration.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ # Using npm
9
+ npm install @paris-ias/list
10
+
11
+ # Using yarn
12
+ yarn add @paris-ias/list
13
+
14
+ # Using pnpm
15
+ pnpm add @paris-ias/list
16
+ ```
17
+
18
+ ## Usage
19
+
20
+ Add the module to your `nuxt.config.ts`:
21
+
22
+ ```ts
23
+ export default defineNuxtConfig({
24
+ modules: ['@paris-ias/list'],
25
+ list: {
26
+ modules: ['events', 'news', 'people', 'projects', 'fellowships', 'publications']
27
+ }
28
+ })
29
+ ```
30
+
31
+ Set up your environment variables:
32
+
33
+ ```env
34
+ GRAPHQL_ENDPOINT=your_graphql_endpoint
35
+ GRAPHQL_API_KEY=your_graphql_api_key
36
+ ```
37
+
38
+ ## Features
39
+
40
+ - List components for different content types
41
+ - GraphQL integration
42
+ - i18n support
43
+ - Vuetify integration
44
+ - TypeScript support
45
+
46
+ ## Components
47
+
48
+ The module provides the following components:
49
+
50
+ - `ListOrganismsList`: A reusable list component that can be used with different content types
51
+
52
+ Example usage:
53
+
54
+ ```vue
55
+ <template>
56
+ <ListOrganismsList type="events" />
57
+ <ListOrganismsList type="news" />
58
+ <ListOrganismsList type="people" />
59
+ </template>
60
+ ```
61
+
62
+ ## License
63
+
64
+ MIT
package/package.json ADDED
@@ -0,0 +1,49 @@
1
+ {
2
+ "name": "@paris-ias/list",
3
+ "version": "1.0.2",
4
+ "private": false,
5
+ "type": "module",
6
+ "main": "./dist/module.mjs",
7
+ "types": "./dist/types.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "import": "./dist/module.mjs",
11
+ "require": "./dist/module.cjs",
12
+ "types": "./dist/types.d.ts"
13
+ }
14
+ },
15
+ "files": [
16
+ "dist",
17
+ "templates"
18
+ ],
19
+ "scripts": {
20
+ "dev": "nuxt dev",
21
+ "build": "nuxt build",
22
+ "generate": "nuxt generate"
23
+ },
24
+ "dependencies": {
25
+ "@mdi/font": "^7.4.47",
26
+ "@nuxt/content": "^2.9.0",
27
+ "@nuxt/image": "^1.10.0",
28
+ "@nuxtjs/mdc": "0.16.1",
29
+ "@pinia/nuxt": "^0.5.5",
30
+ "pinia": "^3.0.1",
31
+ "sass": "^1.78.0",
32
+ "vue": "^3.5.13",
33
+ "vuetify": "3.8.0"
34
+ },
35
+ "devDependencies": {
36
+ "@nuxtjs/apollo": "^5.0.0-alpha.14",
37
+ "@nuxtjs/i18n": "^9.5.2",
38
+ "@paris-ias/data": "^1.8.0",
39
+ "@types/node": "^20.0.0",
40
+ "@vueuse/core": "^13.0.0",
41
+ "graphql-tag": "^2.12.6",
42
+ "nuxt": "^3.16.2",
43
+ "typescript": "^5.6.3",
44
+ "vite-plugin-graphql-loader": "^4.0.4"
45
+ },
46
+ "peerDependencies": {
47
+ "nuxt": "^3.0.0"
48
+ }
49
+ }