useRobotsRule()
Type: function useRobotsRule(rule?: MaybeRef<boolean | string>): Ref<string>
View and control the robots rule using a simple reactivity API.
In a server-side context, this can be used to change the rule used for X-Robots-Tag
header and the robots
meta tag.
In a client-side context you can only read the value of the rule, modifying it will have no effect. This is due to robots only respecting the initial SSR response.
Note: This does not modify the /robots.txt
file, only the X-Robots-Tag
header and the robots
meta tag. Make sure to update your robots.txt
file accordingly.
Providing a boolean
will either enable or disable indexing for the current path using the default rules.
Usage
Accessing the rule:
import { useRobotsRule } from '#imports'
const rule = useRobotsRule()
// Ref<'noindex, nofollow'>
Setting the rule - argument:
import { useRobotsRule } from '#imports'
useRobotsRule('index, nofollow')
// Ref<'index, nofollow'>
useRobotsRule(false)
// Ref<'noindex, nofollow'>
Setting the rule - reactive:
import { useRobotsRule } from '#imports'
const rule = useRobotsRule()
rule.value = 'index, nofollow'
// Ref<'index, nofollow'>