@availity/help v3.0.1

title: Help

Context Provider to assist with Help Menu on Portal for specific pages Field Help Icon to import and access field level support

Installation

npm

npm install @availity/help --save

Yarn

yarn add @availity/help

Page Level Help Example

import React from 'react';
import HelpProvider, { Help } from '@availity/help';

const Example = () => (
  <HelpProvider>
    <Help type="provider" id="1234-5678-9101-1213">
      Some Content You May need documentation for.
    </Help>
  </HelpProvider>
);

Page Level Help Props

id: string

The page level help ID Required

type: string

The page level help type: ie.: provider | vendor | payer | insight. Required

Field Level Help Icon Example

import React from 'react';
import { FieldHelpIcon } from '@availity/help';

const Example = () => (
  <div id="testId">
    Select A Provider <FieldHelpIcon id="1234-5678-910" labelId="testId" />
  </div>
);

Field Help Props

id: string

The field Help ID Required

color?: string

The bootstrap 3 color of the icon. Default:primary

size?: string

The size of the help icon. Default: 1x

labelId?: string

The id of the label for accessibility (aria-describedby). Default: ''