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

fix(web): use right type for icon name at core/EmptyState #1711

Merged
merged 3 commits into from
Oct 29, 2024
Merged

fix(web): use right type for icon name at core/EmptyState #1711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9554b1
fix(web) use right type for icon name at EmptyState
dgdavid Oct 29, 2024
9719d0b
refactor(web) migrate core/EptyState to TypeScript
dgdavid Oct 29, 2024
749db9e
fix(web): drop no longer needed @ts-expect-error
dgdavid Oct 29, 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
30 changes: 13 additions & 17 deletions web/src/components/core/EmptyState.jsx → web/src/components/core/EmptyState.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@
* find current contact information at www.suse.com.
*/

// @ts-check

import React from "react";
import {
EmptyState,
Expand All @@ -30,14 +28,21 @@ import {
Stack,
EmptyStateFooter,
EmptyStateActions,
EmptyStateProps,
EmptyStateHeaderProps,
} from "@patternfly/react-core";
import { Icon } from "~/components/layout";
import { IconProps } from "../layout/Icon";

/**
* @typedef {import("~/components/layout/Icon").IconName} IconName
* @typedef {import("@patternfly/react-core").EmptyStateProps} EmptyStateProps
* @typedef {import("@patternfly/react-core").EmptyStateHeaderProps} EmptyStateHeaderProps
*/
type EmptyStateWrapperProps = {
title: string;
icon: IconProps["name"];
color?: string;
headingLevel?: EmptyStateHeaderProps["headingLevel"];
noPadding?: boolean;
actions?: React.ReactNode;
children?: React.ReactNode;
};

/**
* Convenient wrapper for easing the use of PF/EmptyState component
Expand All @@ -46,15 +51,6 @@ import { Icon } from "~/components/layout";
* directly when dealing with a very specific UI use case and more freedom is
* needed.
*
* @param {object} props
* @param {string} props.title
* @param {IconName} props.icon
* @param {string} [props.color="color-100"]
* @param {EmptyStateHeaderProps["headingLevel"]} [props.headingLevel="h4"]
* @param {boolean} [props.noPadding=false]
* @param {React.ReactNode} [props.actions]
* @param {React.ReactNode} [props.children]
* @param {EmptyStateProps} [props.rest]
* @todo write documentation
*/
export default function EmptyStateWrapper({
Expand All @@ -66,7 +62,7 @@ export default function EmptyStateWrapper({
actions,
children,
...rest
}) {
}: Partial<EmptyStateProps> & EmptyStateWrapperProps) {
// @ts-ignore
if (noPadding) rest.className = [rest.className, "no-padding"].join(" ").trim();

Expand Down
2 changes: 1 addition & 1 deletion web/src/components/layout/Icon.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ const icons = {

const PREDEFINED_SIZES = ["xxxs", "xxs", "xs", "s", "m", "l", "xl", "xxl", "xxxl"];

type IconProps = React.SVGAttributes<SVGElement> & {
export type IconProps = React.SVGAttributes<SVGElement> & {
/** Name of the desired icon */
name: keyof typeof icons;
/** Size used for both, width and height.It can be a CSS unit or one of PREDEFINED_SIZES */
Expand Down
1 change: 0 additions & 1 deletion web/src/components/storage/zfcp/ZFCPPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ const NoDisksFound = () => {
<EmptyState
title={_("No zFCP disks found.")}
icon="warning"
// @ts-expect-error: core/EmptyState props are not well defined
variant="sm"
actions={
activeController && (
Expand Down
Loading