import { Canvas, Meta } from "@storybook/blocks";
import { FunctionArgument, FunctionArguments } from "vibe-storybook-components";
import { TableMediaQuery } from "./useVibeMediaQuery.stories.helpers";
import * as UseVibeMediaQueryStories from "./useVibeMediaQuery.stories";

<Meta of={UseVibeMediaQueryStories} />

# useVibeMediaQuery

- [Overview](#overview)
- [Arguments](#arguments)
- [Returns](#returns)
- [Feedback](#feedback)

## Overview

This hook will return the value of the current vibe break point

<TableMediaQuery />

<Canvas of={UseVibeMediaQueryStories.Overview} />

## Arguments

This hook doesn't receive any parameters

## Returns

<FunctionArguments>
  <FunctionArgument
    name="result"
    type="number"
    description="The current number which reference the current applied breakpoint"
  />
</FunctionArguments>