# useBreakpoints API

> Auto-generated API reference for `useBreakpoints` from @vuetify/v0 (Vuetify0).
> Source of truth: https://0.vuetifyjs.com/api/use-breakpoints

## Related

- https://0.vuetifyjs.com/composables/plugins/use-breakpoints
- https://0.vuetifyjs.com/composables/system/use-media-query
- https://0.vuetifyjs.com/guide/fundamentals/plugins

## Functions

### createBreakpoints

Creates a new breakpoints instance.

```ts
(_options?: BreakpointsOptions) => BreakpointsContext
```

### createBreakpointsContext

```ts
<_E>(_options?: BreakpointsContextOptions | undefined) => ContextTrinity<_E>
```

### createBreakpointsPlugin

```ts
(_options?: BreakpointsContextOptions | undefined) => Plugin
```

### useBreakpoints

```ts
<_E>(namespace?: string) => _E
```

## Options

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `namespace` | `string \| undefined` | — | no | — |
| `mobileBreakpoint` | `number \| BreakpointName \| undefined` | — | no | — |
| `breakpoints` | `Partial<Record<BreakpointName, number>> \| undefined` | — | no | — |
| `ssr` | `{ clientWidth: number; clientHeight?: number; } \| undefined` | — | no | — |

## Methods

| Name | Type | Description |
|---|---|---|
| `update` | `() => void` | — |

## Properties

| Name | Type | Description |
|---|---|---|
| `breakpoints` | `Readonly<Record<BreakpointName, number>>` | — |
| `mobileBreakpoint` | `number \| BreakpointName` | — |
| `name` | `Readonly<ShallowRef<BreakpointName>>` | — |
| `width` | `Readonly<ShallowRef<number>>` | — |
| `height` | `Readonly<ShallowRef<number>>` | — |
| `isMobile` | `Readonly<ShallowRef<boolean>>` | — |
| `xs` | `Readonly<ShallowRef<boolean>>` | — |
| `sm` | `Readonly<ShallowRef<boolean>>` | — |
| `md` | `Readonly<ShallowRef<boolean>>` | — |
| `lg` | `Readonly<ShallowRef<boolean>>` | — |
| `xl` | `Readonly<ShallowRef<boolean>>` | — |
| `xxl` | `Readonly<ShallowRef<boolean>>` | — |
| `smAndUp` | `Readonly<ShallowRef<boolean>>` | — |
| `mdAndUp` | `Readonly<ShallowRef<boolean>>` | — |
| `lgAndUp` | `Readonly<ShallowRef<boolean>>` | — |
| `xlAndUp` | `Readonly<ShallowRef<boolean>>` | — |
| `smAndDown` | `Readonly<ShallowRef<boolean>>` | — |
| `mdAndDown` | `Readonly<ShallowRef<boolean>>` | — |
| `lgAndDown` | `Readonly<ShallowRef<boolean>>` | — |
| `xlAndDown` | `Readonly<ShallowRef<boolean>>` | — |
| `ssr` | `boolean` | — |