Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 | 176x 176x 176x 176x 176x 176x 176x 2x 2x 2x 1x 2x 176x 176x 176x 176x 176x 176x 176x 176x 176x 176x 176x 27x 1x 1x 27x 27x 27x 27x 27x 68x | import _ from 'lodash';
import React from 'react';
import PropTypes from 'react-peek/prop-types';
import { lucidClassNames } from '../../util/style-helpers';
import {
getFirst,
findTypes,
omitProps,
StandardProps,
Overwrite,
} from '../../util/component-types';
import { buildModernHybridComponent } from '../../util/state-management';
import * as reducers from './Tabs.reducers';
import Badge from '../Badge/Badge';
const cx = lucidClassNames.bind('&-Tabs');
const { bool, func, node, number, string, any } = PropTypes;
interface ITitleProps extends StandardProps {}
const Title = (props: ITitleProps): null => null;
Title.peek = {
description: `Titles can be provided as a child or prop to a Tab.`,
};
Title.displayName = 'Tabs.Title';
Title.propName = 'Title';
interface ITabProps extends StandardProps {
/** The index of this \`Tab\` within the list of \`Tabs\`. */
index?: number;
/**Styles a \`Tab\` as disabled. This is typically used with
\`isProgressive\` to disable steps that have not been completed and
should not be selected until the current step has been completed. */
isDisabled?: boolean;
/** If \`true\`, this \`Tab\` is the last \`Tab\` in the list of \`Tabs\`. */
isLastTab?: boolean;
/** If \`true\` then the active \`Tab\` will appear open on the bottom. */
isOpen?: boolean;
/** If \`true\`, the \`Tab\` will appear as a \`Progressive\` tab. */
isProgressive?: boolean;
/** If \`true\`, the \`Tab\` will appear selected. */
isSelected?: boolean;
/** Callback for when the user clicks a \`Tab\`. Called with the index of the
\`Tab\` that was clicked. */
onSelect?: (
index: number,
tabProps: ITabProps,
event: React.MouseEvent<HTMLLIElement>
) => void;
/** The content to be rendered as the \`Title\` of the \`Tab\`. */
Title?: string | (React.ReactNode & { props: ITitleProps });
/** Optional prop that will show a count number next to the tab's title. */
count?: number | string;
/** Defaults to false.
Allows the count bubble to grow large. Useful if working with huge numbers. */
isVariableCountWidth?: boolean;
}
type ITabPropsWithPassThroughs = Overwrite<
React.DetailedHTMLProps<React.HTMLAttributes<HTMLLIElement>, HTMLLIElement>,
ITabProps
>;
const Tab = (props: ITabPropsWithPassThroughs): React.ReactElement => {
const {
isDisabled,
isLastTab,
isOpen,
isProgressive,
isSelected,
Title,
className,
count,
isVariableCountWidth,
index = 0, // this defaults should not be invoked unless someone is using `Tab` outside of `Tabs`
onSelect = _.noop, // this defaults should not be invoked unless someone is using `Tab` outside of `Tabs`
...passThroughs
} = props;
const handleClick = (event: React.MouseEvent<HTMLLIElement>) => {
if (!isDisabled) {
onSelect(index, props, event);
}
};
return (
<li
className={cx(
'&-Tab',
{
'&-Tab-is-active': isSelected,
'&-Tab-is-disabled': isDisabled,
'&-Tab-is-active-and-open': isOpen && isSelected,
'&-Tab-is-progressive': isProgressive && !isLastTab,
},
className
)}
onClick={handleClick}
{...omitProps(passThroughs, undefined, _.keys(Tab.propTypes))}
>
<span className={cx('&-Tab-content')}>
{Title}
{!_.isNil(count) && (
<Badge
style={{
marginLeft: '12px',
width: isVariableCountWidth ? undefined : '20px',
minWidth: '20px',
}}
type='stroke'
kind={isSelected ? 'primary' : undefined}
>
{count}
</Badge>
)}
</span>
{isProgressive && !isLastTab && (
<span className={cx('&-Tab-arrow')}>
<svg
className={cx('&-Tab-arrow-svg')}
viewBox={'0 0 8 37'}
preserveAspectRatio='none'
>
<polyline
className={cx('&-Tab-arrow-tab-line')}
fill='#fff'
points='0,0 1,1 0,1'
/>
<polyline
className={cx('&-Tab-arrow-line')}
fill='none'
stroke='#fff'
strokeWidth='1'
points={'0,37 7.3,18.5 0,0'}
/>
</svg>
</span>
)}
</li>
);
};
Tab.peek = {
description: `
Content that will be rendered in a tab. Be sure to nest a Title inside
each Tab or provide it as a prop. Props other than \`isDisabled\`,
\`isSelected\`, and \`Title\` can be inferred from the parent \`Tabs\`
component, but directly provided \`props\` will take precedence.
`,
};
Tab.displayName = 'Tabs.Tab';
Tab.propName = 'Tab';
Tab.propTypes = {
className: string`
Class names that are appended to the defaults.
`,
index: number`
The index of this \`Tab\` within the list of \`Tabs\`.
`,
isDisabled: bool`
Styles a \`Tab\` as disabled. This is typically used with
\`isProgressive\` to disable steps that have not been completed and
should not be selected until the current step has been completed.
`,
isLastTab: bool`
If \`true\`, this \`Tab\` is the last \`Tab\` in the list of \`Tabs\`.
`,
isOpen: bool`
If \`true\` then the active \`Tab\` will appear open on the bottom.
`,
isProgressive: bool`
If \`true\`, the \`Tab\` will appear as a \`Progressive\` tab.
`,
isSelected: bool`
If \`true\`, the \`Tab\` will appear selected.
`,
onSelect: func`
Callback for when the user clicks a \`Tab\`. Called with the index of the
\`Tab\` that was clicked.
`,
Title: node`
The content to be rendered as the \`Title\` of the \`Tab\`.
`,
count: number`
Optional prop that will show a count number next to the tab's title.
`,
isVariableCountWidth: bool`
Defaults to false.
Allows the count bubble to grow large. Useful if working with huge numbers.
`,
};
interface ITabsProps extends StandardProps {
/** Indicates which of the \`Tabs.Tab\` children is currently selected. The
index of the last \`Tabs.Tab\` child with \`isSelected\` equal to
\`true\` takes precedence over this prop. */
selectedIndex: number;
/** Callback for when the user clicks a tab. Called with the index of the tab
that was clicked. */
onSelect: (
index: number,
{
props,
event,
}: { props: ITabProps; event: React.MouseEvent<HTMLLIElement> }
) => void;
/** If \`true\` then the active tab will appear open on the bottom. */
isOpen: boolean;
/** Style the tabs as a progression. This is typically used for a work flow
where the user needs to move forward and backward through a series of
steps. */
isProgressive: boolean;
/** Provides a small bottom border that offers a barrier between the tab
group and the rest of the page.
Useful if the tabs are not anchored to anything. */
isFloating: boolean;
/** Set the multiline className. This is typically used for styling the
Tab.Title bar for improved readability when there are multiple React
elements in the tab headers. */
hasMultilineTitle: boolean;
/** If \`true\` the width will be evenly distributed to all tabs. \`False\`
typically used in conjunction with \`Tab.width\` */
hasFullWidthTabs: boolean;
/** *Child Element* Can be used to define one or more individual \`Tab\`s in
the sequence of \`Tabs\`. */
Tab?: string | (React.ReactNode & { props: ITabProps });
Title?: string | (React.ReactNode & { props: ITitleProps });
}
type ITabsPropsWithPassThroughs = Overwrite<
React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
ITabsProps
>;
export interface ITabsState {
selectedIndex: number;
}
class Tabs extends React.Component<ITabsPropsWithPassThroughs, ITabsState> {
static displayName = 'Tabs';
static Title = Title;
static Tab = Tab;
static reducers = reducers;
static peek = {
description: `
\`Tabs\` provides tabbed navigation. It has a flexible interface that
allows tab content to be passed as regular React children or through
props.
`,
categories: ['navigation'],
};
static propTypes = {
className: string`
Class names that are appended to the defaults.
`,
selectedIndex: number`
Indicates which of the \`Tabs.Tab\` children is currently selected. The
index of the last \`Tabs.Tab\` child with \`isSelected\` equal to
\`true\` takes precedence over this prop.
`,
onSelect: func`
Callback for when the user clicks a tab. Called with the index of the tab
that was clicked.
`,
isOpen: bool`
If \`true\` then the active tab will appear open on the bottom.
`,
isProgressive: bool`
Style the tabs as a progression. This is typically used for a work flow
where the user needs to move forward and backward through a series of
steps.
`,
isFloating: bool`
Provides a small bottom border that offers a barrier between the tab
group and the rest of the page.
Useful if the tabs are not anchored to anything.
`,
hasMultilineTitle: bool`
Set the multiline className. This is typically used for styling the
Tab.Title bar for improved readability when there are multiple React
elements in the tab headers.
`,
hasFullWidthTabs: bool`
If \`true\` the width will be evenly distributed to all tabs. \`False\`
typically used in conjunction with \`Tab.width\`
`,
Tab: any`
*Child Element* Can be used to define one or more individual \`Tab\`s in
the sequence of \`Tabs\`.
`,
};
static defaultProps = {
selectedIndex: 0,
onSelect: _.noop,
isOpen: true,
isProgressive: false,
isFloating: false,
hasMultilineTitle: false,
hasFullWidthTabs: false,
};
handleClicked = (
index: number,
tabProps: ITabProps,
event: React.MouseEvent<HTMLLIElement>
): void => {
const { onSelect } = this.props;
onSelect(index, { event, props: tabProps });
};
render() {
const {
className,
hasMultilineTitle,
isOpen,
isProgressive,
selectedIndex,
hasFullWidthTabs,
isFloating,
...passThroughs
} = this.props;
// Grab props array from each Tab
const tabChildProps = _.map(findTypes(this.props, Tab), 'props');
const selectedIndexFromChildren = _.findLastIndex(tabChildProps, {
isSelected: true,
});
const actualSelectedIndex =
selectedIndexFromChildren !== -1
? selectedIndexFromChildren
: selectedIndex;
return (
<div
{...omitProps(passThroughs, undefined, _.keys(Tabs.propTypes))}
className={cx('&', className)}
>
<ul
className={cx('&-bar', {
'&-bar-is-multiline': hasMultilineTitle,
'&-variable-width': !hasFullWidthTabs,
'&-floating': isFloating,
})}
>
{_.map(tabChildProps, (tabProps, index) => (
<Tab
key={index}
index={index}
isLastTab={index === tabChildProps.length - 1}
isOpen={isOpen}
isProgressive={isProgressive}
isSelected={index === actualSelectedIndex}
onSelect={this.handleClicked}
Title={_.get(
getFirst(tabProps, Tabs.Title),
'props.children',
''
)}
{...tabProps}
/>
))}
</ul>
<div className={cx('&-content')}>
{_.get(tabChildProps, [
_.isUndefined(actualSelectedIndex) ? '' : actualSelectedIndex,
'children',
])}
</div>
</div>
);
}
}
export default buildModernHybridComponent<ITabsProps, ITabsState, typeof Tabs>(
Tabs,
{ reducers }
);
export { Tabs as TabsDumb };
|