Components
ContextualHelp
Code

ContextualHelp

▸ ContextualHelp(props): null | ReactElement<any, string | JSXElementConstructor<any>>

Shows the user information relative to a context

Parameters

NameType
propsContextualHelpProps & RefAttributes<HTMLDivElement (opens in a new tab)>

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Example

example.tsx
<ContextualHelp label="Meaningful label">Help message</ContextualHelp>
import React from 'react'
import { ContextualHelp } from '@vtex/shoreline-components'

export default function App() {
return (<>
<ContextualHelp label="Meaningful label">
Help message
</ContextualHelp>
</>
)}
Open on CodeSandboxOpen Sandbox

Defined in

node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355

PropsProps