nuxt-viewport

为您的 Nuxt 项目定义自定义视口

78.6K 下载•154 星•v2.3.1

mvrlin

nuxt-viewport

为您的 Nuxt️ 项目定义自定义视口

功能

⚡️ 采用 MatchMedia API 实现快速轻量 ⚡️
🕶 从 Cookie 和 User-Agent 自动检测设备视口
👌 零配置即可开始
👴️ 支持 IE9+

注意
此版本仅适用于 Nuxt 3 和 Nuxt Bridge。对于 Nuxt 2，请参阅 1.0.1

快速设置

将 nuxt-viewport 依赖项添加到您的项目

npx nuxi@latest module add nuxt-viewport

将 nuxt-viewport 添加到 nuxt.config.js 的 modules 部分

{
  modules: [
    [
      'nuxt-viewport', {
        /* Viewport options */
      }
    ],
  ]
}

使用顶级选项

{
  modules: [
    'nuxt-viewport',
  ],

  viewport: {
    /* Viewport options */
  },
}

使用

<script setup>
import { useNuxtApp } from '#app'
const { $viewport } = useNuxtApp()

watch($viewport.breakpoint, (newBreakpoint, oldBreakpoint) => {
  console.log('Breakpoint updated:', oldBreakpoint, '->', newBreakpoint)
})
</script>

<template>
  <div>
    <div v-if="$viewport.isLessThan('tablet')">Should render only on mobile</div>
    <div v-else>Current breakpoint: {{ $viewport.breakpoint }}</div>
  </div>
</template>

与可组合项一起使用

<script setup>
const viewport = useViewport()

watch(viewport.breakpoint, (newBreakpoint, oldBreakpoint) => {
  console.log('Breakpoint updated:', oldBreakpoint, '->', newBreakpoint)
})
</script>

<template>
  <div>
    <div v-if="viewport.isLessThan('tablet')">Should render only on mobile</div>
    <div v-else>Current breakpoint: {{ viewport.breakpoint }}</div>
  </div>
</template>

与 "@nuxt/bridge" 一起使用

<script setup>
const viewport = useViewport()

watch(viewport.breakpoint, (newBreakpoint, oldBreakpoint) => {
  console.log('Breakpoint updated:', oldBreakpoint, '->', newBreakpoint)
})
</script>

<template>
  <div>
    <div v-if="viewport.isLessThan('tablet')">Should render only on mobile</div>
    <div v-else>Current breakpoint: {{ $viewport.breakpoint }}</div>
  </div>
</template>

配置

`断点`

类型: Object

一个对象，其中键是视口的名称，值是视口大小。

类型: Object

一个包含 cookie 选项的对象。详见 https://npmjs.net.cn/package/cookiejs#cookie-attributes

`defaultBreakpoints`

类型: Object
可检测设备：bot, desktop, mobile, tablet, tv

一个对象，其中键是检测到的设备名称，值是断点键。

`fallbackBreakpoint`

类型: String
默认值: viewport

如果未检测到设备，则使用的断点键。

`feature`

类型: 'minWidth' | 'maxWidth'
默认值: 'minWidth'

CSS 媒体特性。

默认配置

{
  // ...
  viewport: {
    breakpoints: {
      desktop: 1024,
      desktopMedium: 1280,
      desktopWide: 1600,

      mobile: 320,
      mobileMedium: 375,
      mobileWide: 425,

      tablet: 768,
    },

    cookie: {
      expires: 365, // 365 days
      name: 'viewport',
      path: '/',
      sameSite: 'Strict',
      secure: true,
    },

    defaultBreakpoints: {
      desktop: 'desktop',
      mobile: 'mobile',
      tablet: 'tablet',
    },

    fallbackBreakpoint: 'desktop',

    feature: 'minWidth',
  },
  // ...
}

Tailwind CSS 的配置示例

{
  // ...
  viewport: {
    breakpoints: {
      xs: 320,
      sm: 640,
      md: 768,
      lg: 1024,
      xl: 1280,
      '2xl': 1536,
    },

    defaultBreakpoints: {
      desktop: 'lg',
      mobile: 'xs',
      tablet: 'md',
    },

    fallbackBreakpoint: 'lg'
  },
  // ...
}

按页面配置

您可以使用 definePageMeta 覆盖特定页面的全局配置。

<script setup>
definePageMeta({
  viewport: {
    breakpoints: {
      desktop: 1024,
      mobile: 320,
      tablet: 768
    },
    cookie: {
      name: 'viewport-per-page'
    }
    // Other fields will be inherited from the global configuration
  }
})
</script>

API

`viewport.breakpoint`

类型: String

当前断点。

`viewport.breakpointValue`

类型: Number

// Example using defaults.

viewport.breakpointValue('desktop') // Result: 1024.
viewport.breakpointValue('tablet') // Result: 768.
viewport.breakpointValue('mobile') // Result: 320.

`viewport.isGreaterThan`

类型: Boolean

// Example: viewport.breakpoint is "mobile".

viewport.isGreaterThan('mobile') // Result: false.
viewport.isGreaterThan('desktop') // Result: false.

`viewport.isGreaterOrEquals`

类型: Boolean

// Example: viewport.breakpoint is "mobile".

viewport.isGreaterOrEquals('mobile') // Result: true.
viewport.isGreaterOrEquals('desktop') // Result: false.

`viewport.isLessThan`

类型: Boolean

// Example: viewport.breakpoint is "desktop".

viewport.isLessThan('desktopWide') // Result: true.
viewport.isLessThan('mobile') // Result: false.

`viewport.isLessOrEquals`

类型: Boolean

// Example: viewport.breakpoint is "tablet".

viewport.isLessOrEquals('tablet') // Result: true.
viewport.isLessOrEquals('mobile') // Result: false.

`viewport.match`

类型: Boolean

// Example: viewport.breakpoint is "tablet".

viewport.match('tablet') // Result: true.
viewport.match('desktop') // Result: false.

`viewport.matches`

类型: Boolean

// Example: viewport.breakpoint is "mobileWide".

viewport.matches('tablet', 'mobileWide') // Result: true.
viewport.matches('mobile', 'tablet') // Result: false.

`viewport.queries`

类型: Object

包含生成的媒体查询的对象。

贡献

您可以通过 CodeSandBox 在线为该模块贡献代码

或在本地

克隆此仓库
使用 yarn install 或 npm install 安装依赖项
使用 yarn dev 或 npm run dev 启动开发服务器

许可证

麻省理工学院许可证