#Display & Platform

#Usage

The useDisplay composable provides information on multiple aspects of the current device.

This enables you to control various aspects of your application based upon the window size, device type, and SSR state. This composable works in conjunction with grids and other responsive utility classes (e.g. display).

The following shows how to access the application’s display information:

<script setup>
  import { onMounted } from 'vue'
  import { useDisplay } from 'vuetify'

  const { mobile } = useDisplay()

  onMounted(() => {
    console.log(mobile.value) // false
  })
</script>

If you are still using the Options API, you can access the display information on the global $vuetify variable. Note that refs are unwrapped here, so you don’t need .value.

<script>
  export default {
    mounted () {
      console.log(this.$vuetify.display.mobile)
    },
  }
</script>

#API

#Breakpoints and Thresholds

Threshold values generate the ranges used for various breakpoints seen throughout vuetify and the useDisplay composable. The system uses an “and up” mentality starting from xs at 0px. The default threshold values are displayed below.

These ranges power the various additional AndUp / AndDown properties accessible in useDisplay

{
  smAndDown: boolean // < 960px
  smAndUp: boolean // > 600px
  mdAndDown: boolean // < 1280px
  mdAndUp: boolean // > 960px
  lgAndDown: boolean // < 1919px
  lgAndUp: boolean // > 1280px
  xlAndDown: boolean // < 2559px
  xlAndUp: boolean // > 1920px
}

#Options

The useDisplay composable has several configuration options, such as the ability to define custom values for breakpoints.

For example, the thresholds option modifies the values used for viewport calculations. The following snippet overrides thresholds values xs through lg and sets mobileBreakpoint to sm.

import { createVuetify} from 'vuetify'

export default createVuetify({
  display: {
    mobileBreakpoint: 'sm',
    thresholds: {
      xs: 0,
      sm: 340,
      md: 540,
      lg: 800,
      xl: 1280,
    },
  },
})

#Examples

In the following example, we use a switch statement and the current breakpoint name to modify the height property of the v-card component:

<template>
  <v-card :height="height">
    ...
  </v-card>
</template>

<script setup>
  import { computed } from 'vue'
  import { useDisplay } from 'vuetify'

  const { name } = useDisplay()

  const height = computed(() => {
    // name is reactive and
    // must use .value
    switch (name.value) {
      case 'xs': return 220
      case 'sm': return 400
      case 'md': return 500
      case 'lg': return 600
      case 'xl': return 800
      case 'xxl': return 1200
    }

    return undefined
  })
</script>

{
  // Breakpoints
  xs: boolean // 0 - 599
  sm: boolean // 600 - 839
  md: boolean // 840 - 1144
  lg: boolean // 1145 - 1544
  xl: boolean // 1545 - 2137
  xxl: boolean // >= 2138
  smAndDown: boolean // < 840
  smAndUp: boolean // > 599
  mdAndDown: boolean // < 1145
  mdAndUp: boolean // > 839
  lgAndDown: boolean // < 1545
  lgAndUp: boolean // > 1144
  xlAndDown: boolean // < 2138
  xlAndUp: boolean // > 1544

  // true if screen width < mobileBreakpoint
  mobile: boolean
  mobileBreakpoint: number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'

  // Current breakpoint name (e.g. 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl')
  name: string

  // The current value of window.innerHeight and window.innerWidth
  height: number
  width: number

  // Device userAgent information
  platform: {
    android: boolean
    ios: boolean
    cordova: boolean
    electron: boolean
    chrome: boolean
    edge: boolean
    firefox: boolean
    opera: boolean
    win: boolean
    mac: boolean
    linux: boolean
    touch: boolean
    ssr: boolean
  }

  // The values used to make Breakpoint calculations
  thresholds: {
    xs: number
    sm: number
    md: number
    lg: number
    xl: number
    xxl: number
  }
}

#Using Setup

Use the useDisplay composable alongside Vue 3’s setup function to harness the power of the Composition API. In this example we show how to toggle the fullscreen property of v-dialog when the mobile breakpoint is active.

<template>
  <v-dialog :fullscreen="mobile">
    ...
  </v-dialog>
</template>

<script setup>
  import { useDisplay } from 'vuetify'

  const { mobile } = useDisplay()
</script>

<template>
  <v-sheet
    :min-height="mdAndUp ? 300 : '20vh'"
    :rounded="xs"
  >
    ...
  </v-sheet>
</template>

<script setup>
  import { useDisplay } from 'vuetify'

  // Destructure only the keys you want to use
  const { xs, mdAndUp } = useDisplay()
</script>

#Component Mobile Breakpoints

Some components within Vuetify have a mobile-breakpoint property which allows you to override the default value. These components reference the global mobileBreakpoint value that is generated at runtime using the provided options in the vuetify.js file.

The following components have built in support for the mobile-breakpoint property:

By default, mobileBreakpoint is set to lg, which means that if the window is less than 1280 pixels in width (which is the default value for the lg threshold), then the useDisplay composable will update its mobile value to true.

For example, the v-banner component implements different styling when its mobile versus desktop. In the following example, The first banner uses the global mobile-breakpoint value of lg while the second overrides this default with 580:

<template>
  <div>
    <v-banner>
      ...
    </v-banner>

    <v-banner mobile-breakpoint="580">
      ...
    </v-banner>
  </div>
</template>

<script setup>
  import { onMounted } from 'vue'
  import { useDisplay } from 'vuetify'

  const { width, mobile } = useDisplay()

  onMounted(() => {
    console.log(width.value) // 960
    console.log(mobile.value) // true
  })
</script>

If the screen width is 1024 pixels, the second banner would not convert into its mobile state.

<script setup>
  import { onMounted } from 'vue'
  import { useDisplay } from 'vuetify'

  const { mobile } = useDisplay({ mobileBreakpoint: 580 })

  // Given a viewport width of 960px
  onMounted(() => {
    console.log(mobile.value) // false
  })
</script>

<template>
  <div
    :class="[
      'v-component',
      displayClasses,
    ]"
  >
    <!-- v-component--mobile -->
  </div>
</template>

<script setup>
  import { defineName } from 'vue'
  import { useDisplay } from 'vuetify'

  const { displayClasses } = useDisplay({ mobileBreakpoint }, 'v-component')
</script>

<template>
  <v-navigation-drawer
    :class="[
      displayClasses, // 'app-drawer--mobile'
    ]"
  >
    ...
  </v-navigation-drawer>
</template>

<script setup>
  import { useDisplay } from 'vuetify'

  const { displayClasses } = useDisplay({ mobileBreakpoint })
</script>