#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>
  import { onMounted } from 'vue'
  import { useDisplay } from 'vuetify'

  export default {
    setup () {
      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>

#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>
  import { computed } from 'vue'
  import { useDisplay } from 'vuetify'

  export default {
    setup () {
      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
      })

      return { height }
    }
  }
</script>

{
  // Breakpoints
  xs: boolean
  sm: boolean
  md: boolean
  lg: boolean
  xl: boolean
  xxl: boolean
  smAndDown: boolean
  smAndUp: boolean
  mdAndDown: boolean
  mdAndUp: boolean
  lgAndDown: boolean
  lgAndUp: boolean
  xlAndDown: boolean
  xlAndUp: boolean

  // 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>
  import { useDisplay } from 'vuetify'

  export default {
    setup () {
      const { mobile } = useDisplay()

      return { mobile }
    },
  }
</script>

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

<script>
  import { useDisplay } from 'vuetify'

  export default {
    setup () {
      // Destructure only the keys we want to use
      const { xs, mdAndUp } = useDisplay()

      return { xs, mdAndUp }
    }
  }
</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. By default, mobileBreakpoint is set to md, which means that if the window is less than 1280 pixels in width (which is the default value for the md threshold), then the useDisplay composable will update its mobile value to true.

For example, the v-banner component implements different styling based upon the value of mobile on the useDisplay composable. In the following example, The first banner uses the global mobile-breakpoint value of md while the second overrides this default with 580. If the screen width is 1024 pixels, the second banner would not convert into its mobile state:

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

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

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

  export default {
    setup () {
      const { width, mobile } = useDisplay()

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