Skip to content

Commit 0b464ed

Browse files
committed
fixed up docstrings in JLIcon namespace
1 parent 277c910 commit 0b464ed

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

packages/ui-components/src/icon/jlicon.tsx

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import React, { RefObject } from 'react';
1+
import React from 'react';
22
import { classes } from 'typestyle';
33
import { iconStyle, IIconStyle } from '../style/icon';
44

@@ -65,7 +65,7 @@ export class JLIcon {
6565
const component = React.forwardRef(
6666
(
6767
{ className, title, tag = 'div', ...propsStyle }: JLIcon.IProps,
68-
ref: RefObject<HTMLDivElement>
68+
ref: React.RefObject<HTMLDivElement>
6969
) => {
7070
const Tag = tag;
7171
const classNames = classes(
@@ -108,14 +108,19 @@ export namespace JLIcon {
108108
*/
109109
export interface IProps extends IIconStyle {
110110
/**
111-
* Extra classNames, used in addition to the typestyle className
111+
* Extra classNames. Used in addition to the typestyle className to
112+
* set the className of the icon's outermost container node
112113
*/
113114
className?: string;
114115

116+
/**
117+
* HTML element tag of the icon's outermost node, which acts as a
118+
* container for the actual svg node
119+
*/
115120
tag?: 'div' | 'span';
116121

117122
/**
118-
* Icon title
123+
* Optional title that will be set on the icon's svg node
119124
*/
120125
title?: string;
121126
}

0 commit comments

Comments
 (0)