From 8e6aa36dab4eb6462bd484b65d5e9417c2014a46 Mon Sep 17 00:00:00 2001
From: p-sw <shinwoo.park@psw.kr>
Date: Sat, 29 Jun 2024 21:53:43 +0900
Subject: [PATCH] docs: improve comment of className builder of vcn

---
 packages/react/lib/vcn.ts | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/packages/react/lib/vcn.ts b/packages/react/lib/vcn.ts
index aacc012..dbadc5d 100644
--- a/packages/react/lib/vcn.ts
+++ b/packages/react/lib/vcn.ts
@@ -216,6 +216,22 @@ export function vcn<
      * Takes any props (including className), and returns the class name.
      * If there is no variant specified in props, then it will fallback to preset, and then default.
      *
+     *
+     * Process priority of variant will be:
+     *
+     * --- Processed as string
+     * 1. Base
+     *
+     * --- Processed as object (it will ignore rest of "not duplicated classname" in lower priority)
+     * 2. Default
+     * 3. Preset (overriding default)
+     * 4. Variant props via component (overriding preset)
+     *
+     * --- Processed as string
+     * 5. Dynamic classNames using variant props
+     * 6. User's className (overriding dynamic)
+     *
+     *
      * @param variantProps - The variant props including className.
      * @returns The class name.
      */