Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: compose legend labels #994

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: compose legend labels #994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cc1d0db
feat: add customRender prop to legend
abdelkd Mar 19, 2024
7dbf650
feat: add story for customRender on legend
abdelkd Mar 19, 2024
911e3bc
feat: add index to renderItem component props
abdelkd Mar 21, 2024
82858cd
update legend story to include renderItem index
abdelkd Mar 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 73 additions & 27 deletions src/components/text-elements/Legend/Legend.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,53 @@ import { ChevronLeftFill, ChevronRightFill } from "assets";

const makeLegendClassName = makeClassName("Legend");

export interface ColorCircleProps {
name: string;
color: string;
activeLegend?: string;
}

const ColorCircle = ({ name, color, activeLegend }: ColorCircleProps) => {
return (
<svg
className={tremorTwMerge(
"flex-none h-2 w-2 mr-1.5",
getColorClassNames(color, colorPalette.text).textColor,
activeLegend && activeLegend !== name ? "opacity-40" : "opacity-100",
)}
fill="currentColor"
viewBox="0 0 8 8"
>
<circle cx={4} cy={4} r={4} />
</svg>
);
};

export interface LegendItemProps {
name: string;
color: Color | string;
onClick?: (name: string, color: Color | string) => void;
activeLegend?: string;
index: number;
customRender:
| ((params: {
name: string;
index: number;
Circle: () => React.JSX.Element;
}) => React.ReactNode | undefined)
| undefined;
}

const LegendItem = ({ name, color, onClick, activeLegend }: LegendItemProps) => {
const LegendItem = ({
name,
color,
onClick,
activeLegend,
customRender,
index,
}: LegendItemProps) => {
const hasOnValueChange = !!onClick;

return (
<li
className={tremorTwMerge(
Expand All @@ -34,32 +72,32 @@ const LegendItem = ({ name, color, onClick, activeLegend }: LegendItemProps) =>
onClick?.(name, color);
}}
>
<svg
className={tremorTwMerge(
"flex-none h-2 w-2 mr-1.5",
getColorClassNames(color, colorPalette.text).textColor,
activeLegend && activeLegend !== name ? "opacity-40" : "opacity-100",
)}
fill="currentColor"
viewBox="0 0 8 8"
>
<circle cx={4} cy={4} r={4} />
</svg>
<p
className={tremorTwMerge(
// common
"whitespace-nowrap truncate text-tremor-default",
// light
"text-tremor-content",
hasOnValueChange ? "group-hover:text-tremor-content-emphasis" : "",
// dark
"dark:text-dark-tremor-content",
activeLegend && activeLegend !== name ? "opacity-40" : "opacity-100",
hasOnValueChange ? "dark:group-hover:text-dark-tremor-content-emphasis" : "",
)}
>
{name}
</p>
{customRender ? (
customRender({
name,
index,
Circle: () => <ColorCircle name={name} activeLegend={activeLegend} color={color} />,
})
) : (
<>
<ColorCircle name={name} activeLegend={activeLegend} color={color} />
<p
className={tremorTwMerge(
// common
"whitespace-nowrap truncate text-tremor-default",
// light
"text-tremor-content",
hasOnValueChange ? "group-hover:text-tremor-content-emphasis" : "",
// dark
"dark:text-dark-tremor-content",
activeLegend && activeLegend !== name ? "opacity-40" : "opacity-100",
hasOnValueChange ? "dark:group-hover:text-dark-tremor-content-emphasis" : "",
)}
>
{name}
</p>
</>
)}
</li>
);
};
Expand Down Expand Up @@ -135,6 +173,11 @@ export interface LegendProps extends React.OlHTMLAttributes<HTMLOListElement> {
onClickLegendItem?: (category: string, color: Color | string) => void;
activeLegend?: string;
enableLegendSlider?: boolean;
renderItem?: (params: {
name: string;
index: number;
Circle: () => React.JSX.Element;
}) => React.ReactNode | undefined;
}

type HasScrollProps = {
Expand All @@ -150,6 +193,7 @@ const Legend = React.forwardRef<HTMLOListElement, LegendProps>((props, ref) => {
onClickLegendItem,
activeLegend,
enableLegendSlider = false,
renderItem = undefined,
...other
} = props;
const scrollableRef = React.useRef<HTMLInputElement>(null);
Expand Down Expand Up @@ -259,6 +303,8 @@ const Legend = React.forwardRef<HTMLOListElement, LegendProps>((props, ref) => {
color={colors[idx]}
onClick={onClickLegendItem}
activeLegend={activeLegend}
customRender={renderItem}
index={idx}
/>
))}
</div>
Expand Down
17 changes: 17 additions & 0 deletions src/stories/text-elements/Legend.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,20 @@ export const CustomColorsConClick: Story = {
},
},
};

export const CustomItem: Story = {
...LegendTemplate,
args: {
categories: ["Category A", "Category B", "Category C"],
renderItem: ({ name, index, Circle }) => {
return (
<>
<Circle />
<p>
{index} - {name}
</p>
</>
);
},
},
};
Loading