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

refactor: added types to SideNavFooter #14863

Merged
merged 7 commits into from
Oct 31, 2023
Merged

refactor: added types to SideNavFooter #14863

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8f127c0
refactor: mrigrate to ts
k-rajat19 Oct 11, 2023
077b7eb
Merge branch 'main' into sidenavfooter
k-rajat19 Oct 13, 2023
ff7feff
Merge branch 'main' into sidenavfooter
k-rajat19 Oct 18, 2023
b0f8e87
Merge branch 'main' of https://github.com/carbon-design-system/carbon…
k-rajat19 Oct 30, 2023
2341deb
Merge branch 'sidenavfooter' of https://github.com/k-rajat19/carbon i…
k-rajat19 Oct 30, 2023
594aa05
fix: added description for each prop
k-rajat19 Oct 31, 2023
6649471
Merge branch 'main' into sidenavfooter
tw15egan Oct 31, 2023
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
9 changes: 8 additions & 1 deletion ...t/src/components/UIShell/SideNavFooter.js → .../src/components/UIShell/SideNavFooter.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@ import React from 'react';
import PropTypes from 'prop-types';
import { usePrefix } from '../../internal/usePrefix';

export interface SideNavFooterProps {
assistiveText: string;
className?: string;
expanded: boolean;
onToggle: (event: React.MouseEvent<HTMLButtonElement>) => void;
Copy link
Collaborator

@tw15egan tw15egan Oct 30, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add descriptions for each type? These can be copied from the PropType definitions

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done :)

}

/**
* SideNavFooter is used for rendering the button at the bottom of the side
* navigation that is a part of the UI Shell. It is responsible for handling the
Expand All @@ -22,7 +29,7 @@ function SideNavFooter({
className: customClassName,
expanded,
onToggle,
}) {
}: SideNavFooterProps) {
const prefix = usePrefix();
const className = cx(`${prefix}--side-nav__footer`, customClassName);
return (
Expand Down