Local setup help needed for Contributing.

pnpm bootstrap -- --scope @refinedev/package-name

pnpm bootstrap -- --scope @refinedev/package-name

pnpm dev --scope @refinedev/package-name

pnpm dev --scope @refinedev/package-name

pnpm test -- --scope @refinedev/package-name

pnpm test -- --scope @refinedev/package-name

pnpm changeset

pnpm changeset

pnpm test -- --scope @refinedev/package-name

pnpm test -- --scope @refinedev/package-name

   npm install -g pnpm@latest
   

   npm install -g pnpm@latest
   

   pnpm "test -- --scope @refinedev/antd"
   

   pnpm "test -- --scope @refinedev/antd"
   

   pnpm nx test @refinedev/antd
   

   pnpm nx test @refinedev/antd
   

   git fetch upstream
   git merge upstream/master
   

   git fetch upstream
   git merge upstream/master
   

   git push origin your-branch-name
   

   git push origin your-branch-name
   

   pnpm changeset
   

   pnpm changeset
   

- [ ] Unchecked item
- [x] Checked item

- [ ] Unchecked item
- [x] Checked item

## PR Checklist

- [ ] The commit message follows our guidelines
- [ ] Tests for the changes have been added
- [ ] Docs have been added / updated

## PR Checklist

- [ ] The commit message follows our guidelines
- [ ] Tests for the changes have been added
- [ ] Docs have been added / updated

## PR Checklist

- [x] The commit message follows our guidelines
- [x] Tests for the changes have been added
- [ ] Docs have been added / updated

## PR Checklist

- [x] The commit message follows our guidelines
- [x] Tests for the changes have been added
- [ ] Docs have been added / updated

---
"@refinedev/core": major
---

Breaking change: Removed deprecated API XYZ. Users need to migrate to the new ABC API.

---
"@refinedev/core": major
---

Breaking change: Removed deprecated API XYZ. Users need to migrate to the new ABC API.

---
"@refinedev/core": minor
---

feat: added x feature #ISSUE_ID

Now with x feature, you can do y.

Resolves #1234

---
"@refinedev/core": minor
---

feat: added x feature #ISSUE_ID

Now with x feature, you can do y.

Resolves #1234

   <type>(optional scope): <description>
   

   <type>(optional scope): <description>
   

feat(core): add useAwesome hook

feat(core): add useAwesome hook

chore: add changeset for recent changes

chore: add changeset for recent changes

pnpm changeset

pnpm changeset

---
"@refinedev/core": minor
---

feat: added x feature #ISSUE_ID

Now with x feature, you can do y.

Resolves #1234

---
"@refinedev/core": minor
---

feat: added x feature #ISSUE_ID

Now with x feature, you can do y.

Resolves #1234

   import { renderButton } from "@test";

   describe("<ButtonName/>", () => {
     it("should render successfully", () => {
       const { getByText } = renderButton(<ButtonName />);
       expect(getByText("Button Text")).toBeTruthy();
     });

     // Add more test cases as needed
   });
   

   import { renderButton } from "@test";

   describe("<ButtonName/>", () => {
     it("should render successfully", () => {
       const { getByText } = renderButton(<ButtonName />);
       expect(getByText("Button Text")).toBeTruthy();
     });

     // Add more test cases as needed
   });
   

   pnpm test -- --scope @refinedev/ui-tests
   

   pnpm test -- --scope @refinedev/ui-tests
   

   pnpm nx test @refinedev/ui-tests
   

   pnpm nx test @refinedev/ui-tests
   

   pnpm "test -- --scope @refinedev/ui-tests"
   

   pnpm "test -- --scope @refinedev/ui-tests"
   

   pnpm run test --scope @refinedev/ui-tests
   

   pnpm run test --scope @refinedev/ui-tests
   

pnpm test

pnpm test

   pnpm nx test @refinedev/ui-tests -- --verbose
   

   pnpm nx test @refinedev/ui-tests -- --verbose
   

   pnpm test --filter @refinedev/ui-tests -- --verbose
   

   pnpm test --filter @refinedev/ui-tests -- --verbose
   

   ls packages/ui-tests/src/tests/buttons
   

   ls packages/ui-tests/src/tests/buttons
   

   pnpm jest packages/ui-tests/src/tests/buttons/YourTestFile.test.js
   

   pnpm jest packages/ui-tests/src/tests/buttons/YourTestFile.test.js
   

test(ui-tests): add tests for button components

test(ui-tests): add tests for button components

test(ui-tests): add unit tests for CreateButton component

test(ui-tests): add unit tests for CreateButton component

test(ui-tests): update DeleteButton tests for new props

test(ui-tests): update DeleteButton tests for new props

   export interface RefineThemedLayoutV2Props {
     // ... other props
     onSiderCollapsed?: (collapsed: boolean) => void;
   }
   

   export interface RefineThemedLayoutV2Props {
     // ... other props
     onSiderCollapsed?: (collapsed: boolean) => void;
   }
   

   <ThemedLayoutContextProvider
     // ... other props
     onSiderCollapsed={onSiderCollapsed}
   >
     {/* ... */}
   </ThemedLayoutContextProvider>
   

   <ThemedLayoutContextProvider
     // ... other props
     onSiderCollapsed={onSiderCollapsed}
   >
     {/* ... */}
   </ThemedLayoutContextProvider>
   

   const setSiderCollapsed = useCallback((collapsed: boolean) => {
     setSiderCollapsedState(collapsed);
     onSiderCollapsed?.(collapsed);
   }, [onSiderCollapsed]);
   

   const setSiderCollapsed = useCallback((collapsed: boolean) => {
     setSiderCollapsedState(collapsed);
     onSiderCollapsed?.(collapsed);
   }, [onSiderCollapsed]);
   

pnpm build --scope @refinedev/mui

pnpm build --scope @refinedev/mui

pnpm nx build @refinedev/mui

pnpm nx build @refinedev/mui

   export interface RefineThemedLayoutV2Props {
     // ... other props
     onSiderCollapsed?: (collapsed: boolean) => void;
   }
   

   export interface RefineThemedLayoutV2Props {
     // ... other props
     onSiderCollapsed?: (collapsed: boolean) => void;
   }
   

   pnpm clean
   pnpm build --scope @refinedev/mui
   

   pnpm clean
   pnpm build --scope @refinedev/mui
   

   const props = {
     // ... other props
     onSiderCollapsed: (collapsed: boolean) => {
       // Your implementation here
     },
   } as RefineThemedLayoutV2Props;
   

   const props = {
     // ... other props
     onSiderCollapsed: (collapsed: boolean) => {
       // Your implementation here
     },
   } as RefineThemedLayoutV2Props;
   

   pnpm clean
   pnpm install
   pnpm build
   

   pnpm clean
   pnpm install
   pnpm build
   

   rm -rf node_modules/.cache
   pnpm build
   

   rm -rf node_modules/.cache
   pnpm build
   

   const props: RefineThemedLayoutV2Props = {
     // other props
     onSiderCollapsed: (collapsed: boolean) => {
       // Your implementation
     },
   };
   

   const props: RefineThemedLayoutV2Props = {
     // other props
     onSiderCollapsed: (collapsed: boolean) => {
       // Your implementation
     },
   };
   

export interface RefineThemedLayoutV2Props {
  // ... existing props
  onSiderCollapsed?: (collapsed: boolean) => void;
}

export const ThemedLayoutV2: React.FC<RefineThemedLayoutV2Props> = ({
  // ... existing props
  onSiderCollapsed,
}) => {
  return (
    <ThemedLayoutContextProvider
      // ... other props
      onSiderCollapsed={onSiderCollapsed}
    >
      {/* ... rest of the component */}
    </ThemedLayoutContextProvider>
  );
};

export interface RefineThemedLayoutV2Props {
  // ... existing props
  onSiderCollapsed?: (collapsed: boolean) => void;
}

export const ThemedLayoutV2: React.FC<RefineThemedLayoutV2Props> = ({
  // ... existing props
  onSiderCollapsed,
}) => {
  return (
    <ThemedLayoutContextProvider
      // ... other props
      onSiderCollapsed={onSiderCollapsed}
    >
      {/* ... rest of the component */}
    </ThemedLayoutContextProvider>
  );
};

export const ThemedLayoutContextProvider: React.FC<{
  // ... existing props
  onSiderCollapsed?: (collapsed: boolean) => void;
}> = ({
  // ... existing props
  onSiderCollapsed,
}) => {
  const [siderCollapsed, setSiderCollapsed] = useState<boolean>(initialSiderCollapsed);

  const setSiderCollapsedWrapped = useCallback((collapsed: boolean) => {
    setSiderCollapsed(collapsed);
    onSiderCollapsed?.(collapsed);
  }, [onSiderCollapsed]);

  return (
    <ThemedLayoutContext.Provider
      value={{
        // ... other values
        siderCollapsed,
        setSiderCollapsed: setSiderCollapsedWrapped,
      }}
    >
      {children}
    </ThemedLayoutContext.Provider>
  );
};

export const ThemedLayoutContextProvider: React.FC<{
  // ... existing props
  onSiderCollapsed?: (collapsed: boolean) => void;
}> = ({
  // ... existing props
  onSiderCollapsed,
}) => {
  const [siderCollapsed, setSiderCollapsed] = useState<boolean>(initialSiderCollapsed);

  const setSiderCollapsedWrapped = useCallback((collapsed: boolean) => {
    setSiderCollapsed(collapsed);
    onSiderCollapsed?.(collapsed);
  }, [onSiderCollapsed]);

  return (
    <ThemedLayoutContext.Provider
      value={{
        // ... other values
        siderCollapsed,
        setSiderCollapsed: setSiderCollapsedWrapped,
      }}
    >
      {children}
    </ThemedLayoutContext.Provider>
  );
};

import { useThemedLayoutContext } from "@contexts/themedLayoutContext";
export const ThemedSiderV2: React.FC<ThemedSiderV2Props> = ({
  // ... existing props
}) => {
  const { siderCollapsed, setSiderCollapsed } = useThemedLayoutContext();

  // Use setSiderCollapsed when handling collapse/expand actions
  const handleCollapse = () => {
    setSiderCollapsed(!siderCollapsed);
  };

  return (
    // ... existing JSX
    <Drawer
      // ... other props
      onClose={handleCollapse}
    >
      {/* ... drawer content */}
    </Drawer>
    // ... rest of the component
  );
};

import { useThemedLayoutContext } from "@contexts/themedLayoutContext";
export const ThemedSiderV2: React.FC<ThemedSiderV2Props> = ({
  // ... existing props
}) => {
  const { siderCollapsed, setSiderCollapsed } = useThemedLayoutContext();

  // Use setSiderCollapsed when handling collapse/expand actions
  const handleCollapse = () => {
    setSiderCollapsed(!siderCollapsed);
  };

  return (
    // ... existing JSX
    <Drawer
      // ... other props
      onClose={handleCollapse}
    >
      {/* ... drawer content */}
    </Drawer>
    // ... rest of the component
  );
};

pnpm build --scope @refinedev/mui

pnpm build --scope @refinedev/mui

import React from "react";
import {
  Drawer,
  Box,
  IconButton,
  // ... other necessary imports
} from "@mui/material";
import {
  ChevronLeft as ChevronLeftIcon,
  ChevronRight as ChevronRightIcon,
  // ... other necessary icons
} from "@mui/icons-material";
import { useThemedLayoutContext } from "@contexts/themedLayoutContext";

export interface ThemedSiderV2Props {
  // ... existing props
}

export const ThemedSiderV2: React.FC<ThemedSiderV2Props> = ({
  // ... existing props
}) => {
  const { siderCollapsed, setSiderCollapsed } = useThemedLayoutContext();

  const handleCollapse = () => {
    setSiderCollapsed(!siderCollapsed);
  };

  return (
    <Drawer
      variant="permanent"
      open={!siderCollapsed}
      onClose={handleCollapse}
      // ... other Drawer props
    >
      <Box
        // ... styling props
      >
        {/* Sider content */}
        {/* ... Your existing sider content */}
      </Box>
      <IconButton onClick={handleCollapse}>
        {siderCollapsed ? <ChevronRightIcon /> : <ChevronLeftIcon />}
      </IconButton>
    </Drawer>
  );
};

import React from "react";
import {
  Drawer,
  Box,
  IconButton,
  // ... other necessary imports
} from "@mui/material";
import {
  ChevronLeft as ChevronLeftIcon,
  ChevronRight as ChevronRightIcon,
  // ... other necessary icons
} from "@mui/icons-material";
import { useThemedLayoutContext } from "@contexts/themedLayoutContext";

export interface ThemedSiderV2Props {
  // ... existing props
}

export const ThemedSiderV2: React.FC<ThemedSiderV2Props> = ({
  // ... existing props
}) => {
  const { siderCollapsed, setSiderCollapsed } = useThemedLayoutContext();

  const handleCollapse = () => {
    setSiderCollapsed(!siderCollapsed);
  };

  return (
    <Drawer
      variant="permanent"
      open={!siderCollapsed}
      onClose={handleCollapse}
      // ... other Drawer props
    >
      <Box
        // ... styling props
      >
        {/* Sider content */}
        {/* ... Your existing sider content */}
      </Box>
      <IconButton onClick={handleCollapse}>
        {siderCollapsed ? <ChevronRightIcon /> : <ChevronLeftIcon />}
      </IconButton>
    </Drawer>
  );
};

pnpm build --scope @refinedev/mui

pnpm build --scope @refinedev/mui

<Drawer
  variant="temporary"
  open={!siderCollapsed}
  onClose={handleCollapse}
  // ... other Drawer props
>
  {/* Drawer content */}
</Drawer>

<Drawer
  variant="temporary"
  open={!siderCollapsed}
  onClose={handleCollapse}
  // ... other Drawer props
>
  {/* Drawer content */}
</Drawer>

pnpm build --scope @refinedev/types

pnpm build --scope @refinedev/types

pnpm build --scope @refinedev/mui

pnpm build --scope @refinedev/mui

pnpm build

pnpm build

   pnpm changeset
   

   pnpm changeset
   

---
"@refinedev/core": minor
---

feat: added x feature #ISSUE_ID

Now with x feature, you can do y.

Resolves #1234

---
"@refinedev/core": minor
---

feat: added x feature #ISSUE_ID

Now with x feature, you can do y.

Resolves #1234

   pnpm nx dev @refinedev/mui
   

   pnpm nx dev @refinedev/mui
   

   pnpm "dev --scope @refinedev/mui"
   

   pnpm "dev --scope @refinedev/mui"
   

   pnpm run dev --scope @refinedev/mui
   

   pnpm run dev --scope @refinedev/mui
   

   cd packages/mui
   pnpm dev
   

   cd packages/mui
   pnpm dev
   

pnpm run dev --scope @refinedev/mui --scope @examples/base-mui

pnpm run dev --scope @refinedev/mui --scope @examples/base-mui

   pnpm nx run-many --target=dev --projects=@refinedev/mui,@examples/base-mui
   

   pnpm nx run-many --target=dev --projects=@refinedev/mui,@examples/base-mui
   

   pnpm "run dev --scope @refinedev/mui --scope @examples/base-mui"
   

   pnpm "run dev --scope @refinedev/mui --scope @examples/base-mui"
   

   pnpm run dev --scope @refinedev/mui --scope @examples/base-mui
   

   pnpm run dev --scope @refinedev/mui --scope @examples/base-mui
   

   cd examples/base-material-ui
   

   cd examples/base-material-ui
   

   pnpm dev
   

   pnpm dev
   

pnpm build --scope @refinedev/mui

pnpm build --scope @refinedev/mui

   import { renderHook } from "@testing-library/react-hooks";
   import { useNavigation } from "@refinedev/core";
   

   import { renderHook } from "@testing-library/react-hooks";
   import { useNavigation } from "@refinedev/core";
   

   describe("useNavigation", () => {
     it("should return navigation functions", () => {
       const { result } = renderHook(() => useNavigation());
       
       expect(result.current.list).toBeDefined();
       expect(result.current.create).toBeDefined();
       expect(result.current.edit).toBeDefined();
       expect(result.current.show).toBeDefined();
       // Add more assertions for other navigation functions
     });

     // Add more test cases for specific scenarios
   });
   

   describe("useNavigation", () => {
     it("should return navigation functions", () => {
       const { result } = renderHook(() => useNavigation());
       
       expect(result.current.list).toBeDefined();
       expect(result.current.create).toBeDefined();
       expect(result.current.edit).toBeDefined();
       expect(result.current.show).toBeDefined();
       // Add more assertions for other navigation functions
     });

     // Add more test cases for specific scenarios
   });
   

   pnpm test --scope @refinedev/core
   

   pnpm test --scope @refinedev/core
   

   cd E:\Refinedev\refine
   

   cd E:\Refinedev\refine
   

   pnpm test --filter @refinedev/core
   

   pnpm test --filter @refinedev/core
   

   pnpm nx test @refinedev/core
   

   pnpm nx test @refinedev/core
   

   cd packages/core
   pnpm test
   

   cd packages/core
   pnpm test
   

   <type>(<optional scope>): <description>
   

   <type>(<optional scope>): <description>
   

   fix(core): update useNavigation to pass meta.query as URL params
   

   fix(core): update useNavigation to pass meta.query as URL params
   

git commit -m "fix(core): update useNavigation to pass meta.query as URL params" -m "Update listUrl, createUrl, editUrl and cloneUrl methods to pass meta.query as query parameters in the generated URLs."

git commit -m "fix(core): update useNavigation to pass meta.query as URL params" -m "Update listUrl, createUrl, editUrl and cloneUrl methods to pass meta.query as query parameters in the generated URLs."

   ## Props

   ### `prop1`

   Description of prop1...

   ### `prop2`

   Description of prop2...
   

   ## Props

   ### `prop1`

   Description of prop1...

   ### `prop2`

   Description of prop2...
   

   ### `onSiderCollapsed`

   `(collapsed: boolean) => void`

   A callback function that is called when the sider's collapsed state changes. It receives a boolean parameter indicating whether the sider is collapsed (`true`) or expanded (`false`).

   #### Usage

   

   ### `onSiderCollapsed`

   `(collapsed: boolean) => void`

   A callback function that is called when the sider's collapsed state changes. It receives a boolean parameter indicating whether the sider is collapsed (`true`) or expanded (`false`).

   #### Usage

   

   This prop allows you to react to changes in the sider's collapsed state, enabling you to implement custom behaviors or persist the state as needed.
   

   This prop allows you to react to changes in the sider's collapsed state, enabling you to implement custom behaviors or persist the state as needed.
   

   | Property | Type | Default | Description |
   | --- | --- | --- | --- |
   | ... | ... | ... | ... |
   | onSiderCollapsed | `(collapsed: boolean) => void` | `undefined` | Callback function called when sider collapsed state changes |
   | ... | ... | ... | ... |
   

   | Property | Type | Default | Description |
   | --- | --- | --- | --- |
   | ... | ... | ... | ... |
   | onSiderCollapsed | `(collapsed: boolean) => void` | `undefined` | Callback function called when sider collapsed state changes |
   | ... | ... | ... | ... |
   

   pnpm build:docs
   

   pnpm build:docs
   

    git add .
    git commit -m "docs(mui): add onSiderCollapsed prop documentation for ThemedLayoutV2"
    

    git add .
    git commit -m "docs(mui): add onSiderCollapsed prop documentation for ThemedLayoutV2"