safeHref

Returns a document-supplied link target as it may be rendered, or undefined when it may not be.

@internote/canvas-sdkFunction
On this page
import { safeHref } from '@internote/canvas-sdk';

Passes http:, https: and mailto: URLs, and anything with no scheme: a path, a query or an anchor. undefined for an empty target or any other scheme, such as javascript:, and the element then renders with no href. Control characters are stripped before the scheme is read.

#Signature

(raw: unknown): string | undefined

#Parameters

raw
The link's href attribute value.

#Example

<a href={safeHref(attrs.href)} target="_blank" rel="noopener noreferrer">{label}</a>

Declared in packages/canvas-sdk/src/content/safe-href.ts:48.

Last updated