From c5b5f8dc5011f8144f00c86b864ca67ab6b90d0e Mon Sep 17 00:00:00 2001
From: Flaminia Cavallo <flaminia@dhis2.org>
Date: Mon, 18 Nov 2024 11:40:37 +0100
Subject: [PATCH] feat: add documentation for simple transfer

---
 components/simple-transfer/types/index.d.ts | 24 +--------------------
 docs/docs/components/simple-transfer.md     | 23 ++++++++++----------
 2 files changed, 13 insertions(+), 34 deletions(-)

diff --git a/components/simple-transfer/types/index.d.ts b/components/simple-transfer/types/index.d.ts
index 7dbf73092..96246cb8e 100644
--- a/components/simple-transfer/types/index.d.ts
+++ b/components/simple-transfer/types/index.d.ts
@@ -1,5 +1,5 @@
 import * as React from 'react'
-import { InputChangeHandler, InputEventHandler } from '@dhis2-ui/input'
+import { InputChangeHandler } from '@dhis2-ui/input'
 
 export interface SimpleTransferProps {
     options: TransferOption[]
@@ -53,28 +53,6 @@ export interface SimpleTransferProps {
 
 export const SimpleTransfer: React.FC<SimpleTransferProps>
 
-export type TransferOptionOnClickProp = (payload: { value: string }) => void
-
-export interface TransferOptionRenderProps extends TransferOption {
-    highlighted: boolean
-    selected: boolean
-    onClick: TransferOptionOnClickProp
-    onDoubleClick: TransferOptionOnClickProp
-}
-
-export interface TransferOptionProps {
-    label: React.ReactNode
-    value: string
-    onClick: TransferOptionOnClickProp
-    onDoubleClick: TransferOptionOnClickProp
-    className?: string
-    dataTest?: string
-    disabled?: boolean
-    highlighted?: boolean
-}
-
-export const TransferOption: React.FC<TransferOptionProps>
-
 export interface TransferOption {
     label: string
     value: string
diff --git a/docs/docs/components/simple-transfer.md b/docs/docs/components/simple-transfer.md
index a9fa71609..ee58508e3 100644
--- a/docs/docs/components/simple-transfer.md
+++ b/docs/docs/components/simple-transfer.md
@@ -3,14 +3,14 @@ title: SimpleTransfer
 ---
 
 import { Demo } from '@site/src/components/DemoComponent.jsx'
-import API from '../../../components/transfer/API.md'
+import API from '../../../components/simple-transfer/API.md'
 
 # SimpleTransfer
 
 A transfer is used to make complex selections from a list of options.
 
 <Demo
-    path="transfer--single-selection"
+    path="simpletransfer--single-selection"
     height="320px"
 />
 
@@ -20,13 +20,14 @@ A transfer is made up of two lists. The _source list_ that shows the available o
 
 ### When to use
 
--   **Choose from many items**. Use a transfer if a user needs to choose from many items. Transfers can work for hundreds of thousands of items.
--   **Ordered selections**. Use a transfer if chosen options need to have a specific order.
--   **Choose from several groups**. Use a transfer if a user needs to choose from several groups into a single set of chosen options.
+-   **Choose from many items**. Use a simple transfer if a user needs to choose from many items. Simple Transfers can work for hundreds of thousands of items.
+-   **Ordered selections**. Use a simple transfer if chosen options need to have a specific order.
+-   **Choose from several groups**. Use a simple transfer if a user needs to choose from several groups into a single set of chosen options.
 
 ### When not to use
 
--   **Choosing from a few items**. Don't use a transfer to choose from a few options. Use a [`Select`](select.md) instead.
+-   **Choosing from a few items**. Don't use a simple transfer to choose from a few options. Use a [`Select`](select.md) instead.
+-   **Wanting to customized the way the options appear**. Don't use a simple transfer if you need to customize the way you option items appear, Use a [`Transfer`](transfer.md) instead.
 
 ## Options
 
@@ -51,7 +52,7 @@ const onChange = (payload) => setSelected(payload.selected)
 ### Header
 
 <Demo
-    path="transfer--header"
+    path="simpletransfer--header"
     height="320px"
     args="leftHeader.type:h4;leftHeader.props.children:Available+Options;rightHeader.props.children:Selected+Options"
 />
@@ -74,7 +75,7 @@ The `header` component in this case is a simple `h4` element.
 ### Footer
 
 <Demo
-    path="transfer--options-footer"
+    path="simpletransfer--options-footer"
     height="320px"
 />
 
@@ -107,7 +108,7 @@ The footer component is as follows:
 ### Reordering
 
 <Demo
-    path="transfer--reordering"
+    path="simpletransfer--reordering"
     height="320px"
 />
 
@@ -125,7 +126,7 @@ The footer component is as follows:
 ### Filtering
 
 <Demo
-    path="transfer--filtered"
+    path="simpletransfer--filtered"
     height="320px"
 />
 
@@ -144,7 +145,7 @@ The footer component is as follows:
 ### Loading
 
 <Demo
-    path="transfer--loading-source"
+    path="simpletransfer--loading-source"
     height="320px"
 />