From ffd9defb484b1a36bbd352768c3822bcc744fd59 Mon Sep 17 00:00:00 2001 From: Gaby Zifferman Date: Thu, 26 Sep 2024 18:44:33 +0200 Subject: [PATCH] chore: deprecation icon docs (#427) --- docs/Foundations/Icons.mdx | 15 +++++++++++++++ src/components/navigation/Dropdown/Dropdown.tsx | 6 +++++- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/Foundations/Icons.mdx b/docs/Foundations/Icons.mdx index 987bea588..380e94c41 100644 --- a/docs/Foundations/Icons.mdx +++ b/docs/Foundations/Icons.mdx @@ -36,3 +36,18 @@ To process the uploaded SVGs with the `SVGPrettifier`, a server must be running ```bash npm run icons-prettifier ``` + +### FAQ: + +Q: What if an icon in Figma has a FontAwesome name or doesn't follow the standard naming format? Should I name it myself? +A: Please contact the design team. They'll provide the correct name and make sure the icon is properly reflected in the design library. + +Q: When do we use mParticle custom icons instead of default Ant Design (AntD) icons? +A: In our design system, Ant Design (AntD) icons are the primary choice across components. However, custom mParticle icons are used in the following scenarios: + +Q: When do we use mParticle custom icons instead of default Ant Design (AntD) icons? +A: In our design system, Ant Design (AntD) icons are the primary choice across components. However, custom mParticle icons are used in the following scenarios: + +- When the design team explicitly requests a customized icon. +- When the AntD library does not offer a suitable icon for a specific use case. +- When an existing AntD icon does not align with mParticle’s design or functional requirements. diff --git a/src/components/navigation/Dropdown/Dropdown.tsx b/src/components/navigation/Dropdown/Dropdown.tsx index e224a52fa..029ee83e8 100644 --- a/src/components/navigation/Dropdown/Dropdown.tsx +++ b/src/components/navigation/Dropdown/Dropdown.tsx @@ -3,7 +3,11 @@ import { type DropdownProps as AntDropdownProps } from 'antd' import { ConfigProvider } from 'src/components' export interface IDropdownProps extends AntDropdownProps {} - +/** + * @deprecated This component is deprecated and will be removed in future versions. + * Please use the Select component instead. You can find more details here: + * https://mparticle.github.io/aquarium/?path=/docs/components-data-entry-select--documentation + */ export const Dropdown = (props: IDropdownProps) => { return (