useFormAction

[MODES: framework, data]

Summary

Reference Documentation ↗

Resolves the URL to the closest route in the component hierarchy instead of the current URL of the app.

This is used internally by Form to resolve the action to the closest route, but can be used generically as well.

tsx

import { useFormAction } from "react-router";

function SomeComponent() {
  // closest route URL
  let action = useFormAction();

  // closest route URL + "destroy"
  let destroyAction = useFormAction("destroy");
}

Signature

tsx

function useFormAction(
  action?: string,
  {
    relative,
  }: {
    relative?: RelativeRoutingType;
  } = ,
): string {}

Params

action

The action to append to the closest route URL. Defaults to the closest route URL.

options.relative

The relative routing type to use when resolving the action. Defaults to "route".

Returns

The resolved action URL.