> ## Documentation Index
> Fetch the complete documentation index at: https://sunpeak.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# useIsMobile

> Detect if the viewport is mobile-sized.

<Badge color="yellow">sunpeak API</Badge>

## Overview

The `useIsMobile` hook detects if the current viewport width is below the mobile breakpoint (768px).

## Import

```tsx theme={null}
import { useIsMobile } from 'sunpeak';
```

## Signature

```tsx theme={null}
function useIsMobile(): boolean
```

## Returns

<ResponseField name="return" type="boolean">
  `true` if viewport width is less than 768px, `false` otherwise.
</ResponseField>

## Usage

```tsx theme={null}
import { useIsMobile } from 'sunpeak';

function MyResource() {
  const isMobile = useIsMobile();

  return (
    <div className={isMobile ? 'mobile-layout' : 'desktop-layout'}>
      {isMobile ? 'Mobile view' : 'Desktop view'}
    </div>
  );
}
```