Skip to content
This repository was archived by the owner on Dec 20, 2023. It is now read-only.

Commit 3391020

Browse files
fix: optional ipx middleware and custom ipx path
1 parent fad833d commit 3391020

File tree

14 files changed

+197
-107
lines changed

14 files changed

+197
-107
lines changed

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,44 @@ npm install --save-dev @cssninja/nuxt-media-viewer
2828
```ts
2929
export default defineNuxtConfig({
3030
modules: [
31+
'@nuxt/devtools', // optional
3132
'@cssninja/nuxt-media-viewer'
3233
]
3334
})
3435
```
3536

36-
3. Go to the media viewer page and start previewing your assets at [http://localhost:3000/__media_viewer__/client](http://localhost:3000/__media_viewer__/client)
37+
3. Go to the media viewer page and start previewing your assets at [http://localhost:3000/__media_viewer__/client](http://localhost:3000/__media_viewer__/client) or open the devtools and click on the `Media Viewer` tab.
3738

3839

40+
## Configuration
41+
42+
```ts
43+
type ModuleOptions = {
44+
/**
45+
* @default false
46+
*/
47+
installIpxMiddleware?: boolean
48+
49+
/**
50+
* @default '/_ipx'
51+
*/
52+
ipxMiddlewarePrefix?: string
53+
}
54+
```
55+
56+
```ts
57+
export default defineNuxtConfig({
58+
modules: [
59+
'@cssninja/nuxt-media-viewer'
60+
],
61+
mediaViewer: {
62+
installIpxMiddleware: false,
63+
ipxMiddlewarePrefix: '/_ipx',
64+
}
65+
})
66+
```
67+
3968
## Development
4069

41-
- Run `npm run dev:prepare` to generate type stubs.
42-
- Use `npm run dev` to start [playground](./playground) in development mode.
70+
- Run `npm run dev` to develop the client UI.
71+
- Use `npm run dev:playground` to start [playground](./playground) in development mode.

package.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"prepack": "pnpm build",
1919
"dev": "nuxi dev src/client",
2020
"dev:playground": "pnpm build && nuxi dev playground",
21-
"dev:prepare": "nuxi prepare src/runtime",
21+
"dev:prepare": "nuxi prepare src/client",
2222
"build": "pnpm dev:prepare && pnpm build:module && pnpm build:client",
2323
"build:client": "nuxi generate src/client",
2424
"build:module": "nuxt-module-build",
@@ -30,17 +30,19 @@
3030
"@nuxt/devtools-ui-kit": "^0.2.3",
3131
"@vueuse/core": "^9.2.0",
3232
"@vueuse/nuxt": "^9.2.0",
33-
"chalk": "^5.0.1",
3433
"consola": "^2.15.3",
3534
"date-fns": "^2.29.3",
3635
"etag": "^1.8.1",
3736
"image-size": "^1.0.2",
3837
"ipx": "1.0.0-2",
3938
"pathe": "^1.1.0",
40-
"qs": "^6.11.0"
39+
"picocolors": "^1.0.0",
40+
"qs": "^6.11.0",
41+
"ufo": "^1.1.0"
4142
},
4243
"devDependencies": {
4344
"@nuxt/devtools": "0.2.3",
45+
"@nuxt/image-edge": "1.0.0-27954023.4cee565",
4446
"@nuxt/module-builder": "latest",
4547
"@nuxtjs/eslint-config-typescript": "latest",
4648
"@types/node": "^18.14.0",

playground/nuxt.config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import MediaViewer from '..'
33
export default defineNuxtConfig({
44
modules: [
55
'@nuxt/devtools',
6+
// '@nuxt/image-edge', @todo
67
// @ts-ignore
78
MediaViewer
89
],

pnpm-lock.yaml

Lines changed: 26 additions & 27 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/client/components/MediaGallery.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ const props = defineProps<{
77
</script>
88

99
<template>
10-
<div class="grid grid-cols-12 gap-4">
10+
<div class="grid grid-cols-3 md:grid-cols-6 lg:grid-cols-12 gap-4">
1111
<MediaGalleryItem
1212
v-for="key in props.assetsKeys"
13-
:asset-key="key"
1413
:key="key"
14+
:asset-key="key"
1515
/>
1616
</div>
1717
</template>

0 commit comments

Comments
 (0)