chore(react): fix review comments

wso2 · Oct 11, 2024 · 262b1c9 · 262b1c9
1 parent a04868a
commit 262b1c9
Show file tree

Hide file tree

Showing 32 changed files with 35 additions and 35 deletions.
diff --git a/packages/react/src/components/Accordion/Accordion.tsx b/packages/react/src/components/Accordion/Accordion.tsx
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
  *
  * WSO2 LLC. licenses this file to you under the Apache License,
  * Version 2.0 (the "License"); you may not use this file except
@@ -40,7 +40,7 @@ const COMPONENT_NAME: string = 'Accordion';
  *
  * Demos:
  *
- * - [Accordion (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-accordion)
+ * - [Accordion (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-accordion)
  * - [Accordion (MUI)](https://mui.com/material-ui/react-accordion/)
  *
  * API:

diff --git a/packages/react/src/components/AccordionDetails/AccordionDetails.tsx b/packages/react/src/components/AccordionDetails/AccordionDetails.tsx
@@ -33,7 +33,7 @@ const COMPONENT_NAME: string = 'AccordionDetails';
  *
  * Demos:
  *
- * - [Accordion (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-accordion)
+ * - [Accordion (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-accordion)
  * - [Accordion (MUI)](https://mui.com/material-ui/react-accordion/)
  *
  * API:

diff --git a/packages/react/src/components/AccordionSummary/AccordionSummary.tsx b/packages/react/src/components/AccordionSummary/AccordionSummary.tsx
@@ -46,7 +46,7 @@ const COMPONENT_NAME: string = 'AccordionSummary';
  *
  * Demos:
  *
- * - [Accordion (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-accordion)
+ * - [Accordion (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-accordion)
  * - [Accordion (MUI)](https://mui.com/material-ui/react-accordion/)
  *
  * API:

diff --git a/packages/react/src/components/AccountOverview/AccountOverview.tsx b/packages/react/src/components/AccountOverview/AccountOverview.tsx
@@ -81,7 +81,7 @@ const COMPONENT_NAME: string = 'AccountOverview';
  *
  * Demos:
  *
- * - [Account Overview (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/patterns-account-overview)
+ * - [Account Overview (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/patterns-account-overview)
  *
  * API:
  *

diff --git a/packages/react/src/components/ActionCard/ActionCard.tsx b/packages/react/src/components/ActionCard/ActionCard.tsx
@@ -56,11 +56,11 @@ export type ActionCardProps<C extends ElementType = ElementType> = CardProps<C>
 const COMPONENT_NAME: string = 'ActionCard';
 
 /**
- * The Action Card component is an extended version of the` Card` component with an action button.
+ * The Action Card component is an extended version of the `Card` component with an action button.
  *
  * Demos:
  *
- * - [Action Card (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-action-card)
+ * - [Action Card (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-action-card)
  *
  * API:
  *

diff --git a/packages/react/src/components/Alert/Alert.tsx b/packages/react/src/components/Alert/Alert.tsx
@@ -37,11 +37,11 @@ export type AlertProps<C extends ElementType = ElementType> = {
 const COMPONENT_NAME: string = 'Alert';
 
 /**
- * The Alert component display brief messages for the user without interrupting their use of the app.
+ * The Alert component displays brief messages to the user without interrupting their use of the app.
  *
  * Demos:
  *
- * - [Alert (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/feedback-alert)
+ * - [Alert (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/feedback-alert)
  * - [Alert (MUI)](https://mui.com/material-ui/react-alert/)
  *
  * API:

diff --git a/packages/react/src/components/AlertTitle/AlertTitle.tsx b/packages/react/src/components/AlertTitle/AlertTitle.tsx
@@ -41,7 +41,7 @@ const COMPONENT_NAME: string = 'AlertTitle';
  *
  * Demos:
  *
- * - [Alert (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/feedback-alert)
+ * - [Alert (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/feedback-alert)
  * - [Alert (MUI)](https://mui.com/material-ui/react-alert/)
  *
  * API:

diff --git a/packages/react/src/components/AppBar/AppBar.tsx b/packages/react/src/components/AppBar/AppBar.tsx
@@ -44,7 +44,7 @@ const COMPONENT_NAME: string = 'AppBar';
  *
  * Demos:
  *
- * - [App Bar (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-app-bar)
+ * - [App Bar (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-app-bar)
  * - [App Bar (MUI)](https://mui.com/material-ui/react-app-bar/)
  *
  * API:

diff --git a/packages/react/src/components/AppShell/AppShell.tsx b/packages/react/src/components/AppShell/AppShell.tsx
@@ -48,7 +48,7 @@ const COMPONENT_NAME: string = 'AppShell';
  *
  * Demos:
  *
- * - [App Shell (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/layout-app-shell)
+ * - [App Shell (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/layout-app-shell)
  *
  * API:
  *

diff --git a/packages/react/src/components/Autocomplete/Autocomplete.tsx b/packages/react/src/components/Autocomplete/Autocomplete.tsx
@@ -41,7 +41,7 @@ const COMPONENT_NAME: string = 'Autocomplete';
  *
  * Demos:
  *
- * - [Autocomplete (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/inputs-autocomplete)
+ * - [Autocomplete (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/inputs-autocomplete)
  * - [Autocomplete (MUI)](https://mui.com/material-ui/react-autocomplete/)
  *
  * API:

diff --git a/packages/react/src/components/Avatar/Avatar.tsx b/packages/react/src/components/Avatar/Avatar.tsx
@@ -53,7 +53,7 @@ const COMPONENT_NAME: string = 'Avatar';
  *
  * Demos:
  *
- * - [Avatar (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-avatar)
+ * - [Avatar (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-avatar)
  * - [Avatar (MUI)](https://mui.com/material-ui/react-avatar/)
  *
  * API:

diff --git a/packages/react/src/components/Backdrop/Backdrop.tsx b/packages/react/src/components/Backdrop/Backdrop.tsx
@@ -44,7 +44,7 @@ const COMPONENT_NAME: string = 'Backdrop';
  *
  * Demos:
  *
- * - [Backdrop (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/feedback-backdrop)
+ * - [Backdrop (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/feedback-backdrop)
  * - [Backdrop (MUI)](https://mui.com/material-ui/react-backdrop/)
  *
  * API:

diff --git a/packages/react/src/components/Carousel/Carousel.tsx b/packages/react/src/components/Carousel/Carousel.tsx
@@ -98,7 +98,7 @@ const COMPONENT_NAME: string = 'Carousel';
  *
  * Demos:
  *
- * - [Carousel(Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/patterns-carousel)
+ * - [Carousel(Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/patterns-carousel)
  *
  * API:
  *

diff --git a/packages/react/src/components/CircularProgressAvatar/CircularProgressAvatar.tsx b/packages/react/src/components/CircularProgressAvatar/CircularProgressAvatar.tsx
@@ -53,7 +53,7 @@ const COMPONENT_NAME: string = 'CircularProgressAvatar';
  * Demos:
  *
  * // TODO: Move this demo to the Progress demo.
- * - [Circular Progress Avatar (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-circular-progress-avatar)
+ * - [Circular Progress Avatar (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-circular-progress-avatar)
  *
  * API:
  *

diff --git a/packages/react/src/components/Code/Code.tsx b/packages/react/src/components/Code/Code.tsx
@@ -46,7 +46,7 @@ const COMPONENT_NAME: string = 'Code';
  *
  * Demos:
  *
- * - [Code (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-code)
+ * - [Code (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-code)
  *
  * API:
  *

diff --git a/packages/react/src/components/CollapsibleNavbarItem/CollapsibleNavbarItem.tsx b/packages/react/src/components/CollapsibleNavbarItem/CollapsibleNavbarItem.tsx
@@ -55,7 +55,7 @@ const COMPONENT_NAME: string = 'CollapsibleNavbarItem';
  *
  * Demos:
  *
- * - [Collapsible Navbar Item (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-collapsible-navbar-item)
+ * - [Collapsible Navbar Item (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-collapsible-navbar-item)
  *
  * API:
  *

diff --git a/packages/react/src/components/DataGrid/DataGrid.tsx b/packages/react/src/components/DataGrid/DataGrid.tsx
@@ -36,7 +36,7 @@ const COMPONENT_NAME: string = 'DataGrid';
  *
  * Demos:
  *
- * - [Data Grid (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-datagrid)
+ * - [Data Grid (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-datagrid)
  * - [Data Grid (MUI X)](https://mui.com/x/react-data-grid/)
  *
  * API:

diff --git a/packages/react/src/components/Drawer/Drawer.tsx b/packages/react/src/components/Drawer/Drawer.tsx
@@ -40,7 +40,7 @@ const COMPONENT_NAME: string = 'Drawer';
  *
  * Demos:
  *
- * - [Drawer (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-drawer)
+ * - [Drawer (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-drawer)
  * - [Drawer (MUI)](https://mui.com/material-ui/react-drawer/)
  *
  * API:

diff --git a/packages/react/src/components/Footer/Footer.tsx b/packages/react/src/components/Footer/Footer.tsx
@@ -54,7 +54,7 @@ const COMPONENT_NAME: string = 'Footer';
  *
  * Demos:
  *
- * - [Footer (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-footer)
+ * - [Footer (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-footer)
  *
  * @remarks
  * - ✨ This is a custom component that is not available in the Material-UI library.

diff --git a/packages/react/src/components/Header/Header.tsx b/packages/react/src/components/Header/Header.tsx
@@ -141,7 +141,7 @@ const COMPONENT_NAME: string = 'Header';
  *
  * Demos:
  *
- * - [Header (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-header)
+ * - [Header (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-header)
  *
  * API:
  *

diff --git a/packages/react/src/components/Image/Image.tsx b/packages/react/src/components/Image/Image.tsx
@@ -34,7 +34,7 @@ const COMPONENT_NAME: string = 'Image';
  *
  * Demos:
  *
- * - [Image (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-image)
+ * - [Image (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-image)
  *
  * @remarks
  * - ✨ This is a custom component that is not available in the Material-UI library.

diff --git a/packages/react/src/components/Menu/Menu.tsx b/packages/react/src/components/Menu/Menu.tsx
@@ -39,7 +39,7 @@ const COMPONENT_NAME: string = 'Menu';
  *
  * Demos:
  *
- * - [App Bar (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-app-bar)
+ * - [App Bar (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-app-bar)
  * - [App Bar (MUI)](https://mui.com/material-ui/react-app-bar/)
  * - [Menu (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-menu)
  * - [Menu (MUI)](https://mui.com/material-ui/react-menu/)

diff --git a/packages/react/src/components/Navbar/Navbar.tsx b/packages/react/src/components/Navbar/Navbar.tsx
@@ -87,7 +87,7 @@ const COMPONENT_NAME: string = 'Navbar';
  *
  * Demos:
  *
- * - [Navvar (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-navbar)
+ * - [Navvar (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-navbar)
  *
  * API:
  *

diff --git a/packages/react/src/components/NavbarItem/NavbarItem.tsx b/packages/react/src/components/NavbarItem/NavbarItem.tsx
@@ -66,7 +66,7 @@ const COMPONENT_NAME: string = 'NavbarItem';
  *
  * Demos:
  *
- * - [Navbar Item (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-navbar-item)
+ * - [Navbar Item (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-navbar-item)
  *
  * API:
  *

diff --git a/packages/react/src/components/PhoneNumberInput/PhoneNumberInput.tsx b/packages/react/src/components/PhoneNumberInput/PhoneNumberInput.tsx
@@ -89,7 +89,7 @@ const COMPONENT_NAME: string = 'PhoneNumberInput';
  *
  * Demos:
  *
- * - [Phone Number Input (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/inputs-phone-number-input)
+ * - [Phone Number Input (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/inputs-phone-number-input)
  *
  * API:
  *

diff --git a/packages/react/src/components/SignIn/SignIn.tsx b/packages/react/src/components/SignIn/SignIn.tsx
@@ -58,7 +58,7 @@ const COMPONENT_NAME: string = 'SignIn';
  *
  * Demos:
  *
- * - [Sign In (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/patterns-sign-in--overview)
+ * - [Sign In (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/patterns-sign-in--overview)
  *
  * API:
  *

diff --git a/packages/react/src/components/Stepper/Stepper.tsx b/packages/react/src/components/Stepper/Stepper.tsx
@@ -48,7 +48,7 @@ const COMPONENT_NAME: string = 'Stepper';
  *
  * Demos:
  *
- * - [Stepper (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-stepper--overview)
+ * - [Stepper (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-stepper--overview)
  *
  * API:
  *

diff --git a/packages/react/src/components/TabPanel/TabPanel.tsx b/packages/react/src/components/TabPanel/TabPanel.tsx
@@ -44,7 +44,7 @@ const COMPONENT_NAME: string = 'TabPanel';
  *
  * Demos:
  *
- * - [TabPanel (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-tab-panel--overview)
+ * - [TabPanel (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/navigation-tab-panel--overview)
  *
  * API:
  *

diff --git a/packages/react/src/components/TextField/TextField.tsx b/packages/react/src/components/TextField/TextField.tsx
@@ -154,7 +154,7 @@ const PasswordFieldWithCriteria: ForwardRefExoticComponent<TextFieldProps> & Wit
  *
  * Demos:
  *
- * - [Autocomplete (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/inputs-autocomplete)
+ * - [Autocomplete (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/inputs-autocomplete)
  * - [Autocomplete (MUI)](https://mui.com/material-ui/react-autocomplete/)
  * - [Text Field (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/inputs-text-field)
  * - [Text Field (MUI)](https://mui.com/material-ui/react-text-field/)

diff --git a/packages/react/src/components/Toolbar/Toolbar.tsx b/packages/react/src/components/Toolbar/Toolbar.tsx
@@ -44,7 +44,7 @@ const COMPONENT_NAME: string = 'Toolbar';
  *
  * Demos:
  *
- * - [App Bar (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-app-bar)
+ * - [App Bar (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/surfaces-app-bar)
  * - [App Bar (MUI)](https://mui.com/material-ui/react-app-bar/)
  *
  * API:

diff --git a/packages/react/src/components/UserDropdownMenu/UserDropdownMenu.tsx b/packages/react/src/components/UserDropdownMenu/UserDropdownMenu.tsx
@@ -127,7 +127,7 @@ const COMPONENT_NAME: string = 'UserDropdownMenu';
  *
  * Demos:
  *
- * - [UserDropdownMenu (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-image)
+ * - [UserDropdownMenu (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-image)
  *
  * API:
  *

diff --git a/packages/react/src/components/Wizard/Wizard.tsx b/packages/react/src/components/Wizard/Wizard.tsx
@@ -100,7 +100,7 @@ const COMPONENT_NAME: string = 'Wizard';
  *
  * Demos:
  *
- * - [Wizard (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/patterns-wizard)
+ * - [Wizard (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/patterns-wizard)
  *
  * API:
  *
-Original file line number
+Diff line change
@@ Expand Up / @@ -81,7 +81,7 @@ const COMPONENT_NAME: string = 'AccountOverview'; @@
      *
      * Demos:
      *
-     * - [Account Overview (Oxygen UI)] (https://wso2.github.io/oxygen-ui/react/?path=/docs/patterns-account-overview)
+     * - [Account Overview (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/patterns-account-overview)
      *
      * API:
      *
@@ Expand Down @@