Skip to content

Commit d1d404f

Browse files
committed
rename
1 parent 082cdd1 commit d1d404f

File tree

3 files changed

+15
-12
lines changed

3 files changed

+15
-12
lines changed

packages/ui-components/Common/CircularIcon/index.module.css renamed to packages/ui-components/Common/DataTag/index.module.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
@reference "../../styles/index.css";
22

3-
.icon {
3+
.dataTag {
44
@apply flex
55
items-center
66
justify-center

packages/ui-components/Common/CircularIcon/index.stories.tsx renamed to packages/ui-components/Common/DataTag/index.stories.tsx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
import type { Meta as MetaObj, StoryObj } from '@storybook/react';
22

3-
import CircularIcon, { type CircularIconProps } from '#ui/Common/CircularIcon';
3+
import DataTag, { type DataTagProps } from '#ui/Common/DataTag';
44

5-
type Story = StoryObj<typeof CircularIcon>;
6-
type Meta = MetaObj<typeof CircularIcon>;
5+
type Story = StoryObj<typeof DataTag>;
6+
type Meta = MetaObj<typeof DataTag>;
77

8-
export const Icons: Story = {
8+
export const DataTags: Story = {
99
render: () => (
1010
<div className="grid grid-cols-3 gap-6 p-6">
1111
{['event', 'method', 'property', 'class', 'module', 'classMethod', 'ctor']
1212
.map(kind =>
1313
['sm', 'md', 'lg'].map(size => (
1414
<div key={`${kind}-${size}`} className="flex justify-center">
15-
<CircularIcon
16-
kind={kind as CircularIconProps['kind']}
17-
size={size as CircularIconProps['size']}
15+
<DataTag
16+
kind={kind as DataTagProps['kind']}
17+
size={size as DataTagProps['size']}
1818
/>
1919
</div>
2020
))
@@ -24,4 +24,4 @@ export const Icons: Story = {
2424
),
2525
};
2626

27-
export default { component: CircularIcon } as Meta;
27+
export default { component: DataTag } as Meta;

packages/ui-components/Common/CircularIcon/index.tsx renamed to packages/ui-components/Common/DataTag/index.tsx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import classNames from 'classnames';
22

33
import styles from './index.module.css';
44

5-
export type CircularIconProps = {
5+
export type DataTagProps = {
66
kind:
77
| 'event'
88
| 'method'
@@ -14,6 +14,9 @@ export type CircularIconProps = {
1414
size?: 'lg' | 'md' | 'sm';
1515
};
1616

17+
// These symbols match up with the types used in
18+
// node core, and the ones defined at
19+
// https://github.com/nodejs/api-docs-tooling/blob/main/src/types.d.ts#L22 (`HeadingMetadataEntry['type']`)
1720
const symbolMap = {
1821
event: 'E',
1922
method: 'M',
@@ -24,9 +27,9 @@ const symbolMap = {
2427
ctor: 'C',
2528
} as const;
2629

27-
export default function CircularIcon({ kind, size = 'md' }: CircularIconProps) {
30+
export default function DataTag({ kind, size = 'md' }: DataTagProps) {
2831
return (
29-
<div className={classNames(styles.icon, styles[size], styles[kind])}>
32+
<div className={classNames(styles.dataTag, styles[size], styles[kind])}>
3033
<span>{symbolMap[kind]}</span>
3134
</div>
3235
);

0 commit comments

Comments
 (0)