Allow ref on the Tag component
Signed-off-by: Gustaf Räntilä <g.rantila@gmail.com>
This commit is contained in:
committed by
Johan Persson
parent
8c2068cbb4
commit
5c76d13ada
@@ -0,0 +1,7 @@
|
||||
---
|
||||
'@backstage/ui': patch
|
||||
---
|
||||
|
||||
Allow `ref` as a prop on the `Tag` component
|
||||
|
||||
Affected components: Tag
|
||||
@@ -1894,7 +1894,9 @@ export const TabsDefinition: {
|
||||
export interface TabsProps extends TabsProps_2 {}
|
||||
|
||||
// @public
|
||||
export const Tag: (props: TagProps) => JSX_2.Element;
|
||||
export const Tag: ForwardRefExoticComponent<
|
||||
TagProps & RefAttributes<HTMLDivElement>
|
||||
>;
|
||||
|
||||
// @public
|
||||
export const TagGroup: <T extends object>(
|
||||
|
||||
@@ -21,7 +21,7 @@ import {
|
||||
Tag as ReactAriaTag,
|
||||
Button as ReactAriaButton,
|
||||
} from 'react-aria-components';
|
||||
import type { ReactNode } from 'react';
|
||||
import { forwardRef, type PropsWithRef, type ReactNode, type Ref } from 'react';
|
||||
import { RiCloseCircleLine } from '@remixicon/react';
|
||||
import clsx from 'clsx';
|
||||
import { useStyles } from '../../hooks/useStyles';
|
||||
@@ -64,47 +64,50 @@ export const TagGroup = <T extends object>(props: TagGroupProps<T>) => {
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
export const Tag = (props: TagProps) => {
|
||||
const { classNames, cleanedProps } = useStyles(TagGroupDefinition, {
|
||||
size: 'small',
|
||||
...props,
|
||||
});
|
||||
const { children, className, icon, size, href, ...rest } = cleanedProps;
|
||||
const textValue = typeof children === 'string' ? children : undefined;
|
||||
export const Tag = forwardRef(
|
||||
(props: PropsWithRef<TagProps>, ref: Ref<HTMLDivElement>) => {
|
||||
const { classNames, cleanedProps } = useStyles(TagGroupDefinition, {
|
||||
size: 'small',
|
||||
...props,
|
||||
});
|
||||
const { children, className, icon, size, href, ...rest } = cleanedProps;
|
||||
const textValue = typeof children === 'string' ? children : undefined;
|
||||
|
||||
useRoutingRegistrationEffect(href);
|
||||
useRoutingRegistrationEffect(href);
|
||||
|
||||
return (
|
||||
<ReactAriaTag
|
||||
textValue={textValue}
|
||||
className={clsx(classNames.tag, styles[classNames.tag], className)}
|
||||
data-size={size}
|
||||
href={href}
|
||||
{...rest}
|
||||
>
|
||||
{({ allowsRemoving }) => (
|
||||
<>
|
||||
{icon && (
|
||||
<span
|
||||
className={clsx(classNames.tagIcon, styles[classNames.tagIcon])}
|
||||
>
|
||||
{icon}
|
||||
</span>
|
||||
)}
|
||||
{children as ReactNode}
|
||||
{allowsRemoving && (
|
||||
<ReactAriaButton
|
||||
className={clsx(
|
||||
classNames.tagRemoveButton,
|
||||
styles[classNames.tagRemoveButton],
|
||||
)}
|
||||
slot="remove"
|
||||
>
|
||||
<RiCloseCircleLine size={16} />
|
||||
</ReactAriaButton>
|
||||
)}
|
||||
</>
|
||||
)}
|
||||
</ReactAriaTag>
|
||||
);
|
||||
};
|
||||
return (
|
||||
<ReactAriaTag
|
||||
ref={ref}
|
||||
textValue={textValue}
|
||||
className={clsx(classNames.tag, styles[classNames.tag], className)}
|
||||
data-size={size}
|
||||
href={href}
|
||||
{...rest}
|
||||
>
|
||||
{({ allowsRemoving }) => (
|
||||
<>
|
||||
{icon && (
|
||||
<span
|
||||
className={clsx(classNames.tagIcon, styles[classNames.tagIcon])}
|
||||
>
|
||||
{icon}
|
||||
</span>
|
||||
)}
|
||||
{children as ReactNode}
|
||||
{allowsRemoving && (
|
||||
<ReactAriaButton
|
||||
className={clsx(
|
||||
classNames.tagRemoveButton,
|
||||
styles[classNames.tagRemoveButton],
|
||||
)}
|
||||
slot="remove"
|
||||
>
|
||||
<RiCloseCircleLine size={16} />
|
||||
</ReactAriaButton>
|
||||
)}
|
||||
</>
|
||||
)}
|
||||
</ReactAriaTag>
|
||||
);
|
||||
},
|
||||
);
|
||||
|
||||
Reference in New Issue
Block a user