chore: add comments

nishiki-tech · Dec 14, 2023 · 59e4d7c · 59e4d7c
1 parent 267064f
commit 59e4d7c
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 0 deletions.
diff --git a/src/components/ui/Button.tsx b/src/components/ui/Button.tsx
@@ -1,3 +1,9 @@
+/**
+ * This file is based on the Button component from shadcn and customized for our needs.
+ *
+ * See the official docs for more info:
+ * shadcn/ui: https://ui.shadcn.com/docs/components/button
+ */
 import { cn } from '@/lib/tailwind/utils';
 
 import { Slot } from '@radix-ui/react-slot';

diff --git a/src/components/ui/Label.tsx b/src/components/ui/Label.tsx
@@ -1,3 +1,10 @@
+/**
+ * This file is based on the Label component from shadcn and customized for our needs.
+ *
+ * See the official docs for more info:
+ * shadcn/ui: https://ui.shadcn.com/docs/components/label
+ * Radix UI: https://www.radix-ui.com/primitives/docs/components/label
+ */
 import { cn } from '@/lib/tailwind/utils';
 
 import { Root as PrimitiveRoot } from '@radix-ui/react-label';

diff --git a/src/components/ui/SelectionDrawer/SelectionDrawerButton.tsx b/src/components/ui/SelectionDrawer/SelectionDrawerButton.tsx
@@ -1,3 +1,9 @@
+/**
+ * This file is based on the Button component from shadcn and customized for our needs.
+ *
+ * See the official docs for more info:
+ * shadcn/ui: https://ui.shadcn.com/docs/components/button
+ */
 import { cn } from '@/lib/tailwind/utils';
 
 import { Slot } from '@radix-ui/react-slot';
@@ -32,6 +38,9 @@ interface ISelectionDrawerIconProps {
   className?: string;
 }
 
+/**
+ * This is a custom component that we use to wrap the Icon in the button.
+ */
 const SelectionDrawerButtonIcon = forwardRef<HTMLDivElement, ISelectionDrawerIconProps>(
   ({ children, className }, ref) => {
     return (
@@ -51,6 +60,9 @@ interface ISelectionDrawerLabelProps {
   className?: string;
 }
 
+/**
+ * This is a custom component that we use to wrap the text in the button.
+ */
 const SelectionDrawerButtonText = forwardRef<HTMLSpanElement, ISelectionDrawerLabelProps>(
   ({ children, className }, ref) => {
     return (

diff --git a/src/components/ui/SelectionDrawer/SelectionDrawerRadioGroup.tsx b/src/components/ui/SelectionDrawer/SelectionDrawerRadioGroup.tsx
@@ -1,3 +1,10 @@
+/**
+ * This file is based on the Radio Group component from shadcn and customized for our needs.
+ *
+ * See the official docs for more info:
+ * shadcn/ui:https://ui.shadcn.com/docs/components/radio-group
+ * Radix UI: https://www.radix-ui.com/primitives/docs/components/radio-group
+ */
 import { cn } from '@/lib/tailwind/utils';
 
 import {