Navigation

Search…

Navigation

API Reference
useNavigation
A hook that lets you push and pop view components in the navigation stack.
You most likely won't use this hook too often. To push a new component, use the Push Action. When a user presses ESC, we automatically pop to the previous component.
Signature
function useNavigation(): Navigation;
Example
import { ActionPanel, Detail, useNavigation } from "@raycast/api";
​
function Ping() {
  const { push } = useNavigation();
​
  return (
    <Detail
      markdown="Ping"
      actions={
        <ActionPanel>
          <ActionPanel.Item title="Push" onAction={() => push(<Pong />)} />
        </ActionPanel>
      }
    />
  );
}
​
function Pong() {
  const { pop } = useNavigation();
​
  return (
    <Detail
      markdown="Pong"
      actions={
        <ActionPanel>
          <ActionPanel.Item title="Pop" onAction={pop} />
        </ActionPanel>
      }
    />
  );
}
​
export default function Command() {
  return <Ping />;
}
Return
A Navigation object with Navigation.push and Navigation.pop functions. Use the functions to alter the navigation stack.
Types
Navigation
Return type of the useNavigation hook to perform push and pop actions.
Properties
Property
Description
Type
pop*
Pop current view component from the navigation stack.
() => void
push*
Push a new view component to the navigation stack.
(component: React.ReactNode) => void

Icons & Images

Next - API Reference

Window & Search Bar

Last modified 4mo ago

Copy link

Edit on GitHub

On this page

API Reference

useNavigation

Types

Navigation