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

chore: deprecation icon docs #427

Merged
merged 2 commits into from
Sep 26, 2024
Merged

chore: deprecation icon docs #427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59fdbe3
feat: deprecate Dropdown and add docs to icon
gabyzif Sep 26, 2024
5ca1195
Merge branch 'main' into feat/deprecation-icon-docs
gabyzif Sep 26, 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
15 changes: 15 additions & 0 deletions docs/Foundations/Icons.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 5 additions & 1 deletion src/components/navigation/Dropdown/Dropdown.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
<ConfigProvider>
Expand Down
Loading