From 478ed3fe07e1a144a2ddb2a1bbd0c3ea8dcfd2ce Mon Sep 17 00:00:00 2001
From: Dominik Dosoudil <eziotegg@gmail.com>
Date: Fri, 15 Nov 2024 18:25:00 +0100
Subject: [PATCH] refactor: rename classNameBuilder utils from use* -> get*
 because prefix 'use' should only be used for hooks

---
 src/lib/classNameBuilders.js | 51 ++++++++++++++++++++++++++++++------
 1 file changed, 43 insertions(+), 8 deletions(-)

diff --git a/src/lib/classNameBuilders.js b/src/lib/classNameBuilders.js
index 17fce336a5..09834376d0 100644
--- a/src/lib/classNameBuilders.js
+++ b/src/lib/classNameBuilders.js
@@ -19,7 +19,12 @@ import { numberToWord } from './numberToWord'
  * <Label tag />
  * <div class="ui tag label"></div>
  */
-export const useKeyOnly = (val, key) => val && key
+export const getKeyOnly = (val, key) => val && key
+
+/**
+ * @deprecated
+ */
+export const useKeyOnly = getKeyOnly
 
 /**
  * Props that require both a key and value to create a className.
@@ -30,7 +35,12 @@ export const useKeyOnly = (val, key) => val && key
  * <Label corner='left' />
  * <div class="ui left corner label"></div>
  */
-export const useValueAndKey = (val, key) => val && val !== true && `${val} ${key}`
+export const getValueAndKey = (val, key) => val && val !== true && `${val} ${key}`
+
+/**
+ * @deprecated
+ */
+export const useValueAndKey = getValueAndKey
 
 /**
  * Props whose key will be used in className, or value and key.
@@ -45,7 +55,12 @@ export const useValueAndKey = (val, key) => val && val !== true && `${val} ${key
  * <Label pointing='left' />
  * <div class="ui left pointing label"></div>
  */
-export const useKeyOrValueAndKey = (val, key) => val && (val === true ? key : `${val} ${key}`)
+export const getKeyOrValueAndKey = (val, key) => val && (val === true ? key : `${val} ${key}`)
+
+/**
+ * @deprecated
+ */
+export const useKeyOrValueAndKey = getKeyOrValueAndKey
 
 //
 // Prop to className exceptions
@@ -63,7 +78,7 @@ export const useKeyOrValueAndKey = (val, key) => val && (val === true ? key : `$
  * <div class="mobile only row"></div>
  * <div class="mobile only tablet only row"></div>
  */
-export const useMultipleProp = (val, key) => {
+export const getMultipleProp = (val, key) => {
   if (!val || val === true) return null
 
   return val
@@ -74,6 +89,11 @@ export const useMultipleProp = (val, key) => {
     .join(' ')
 }
 
+/**
+ * @deprecated
+ */
+export const useMultipleProp = getMultipleProp
+
 /**
  * The "textAlign" prop follows the useValueAndKey except when the value is "justified'.
  * In this case, only the class "justified" is used, ignoring the "aligned" class.
@@ -87,8 +107,13 @@ export const useMultipleProp = (val, key) => {
  * <Container textAlign='left' />
  * <div class="ui left aligned container"></div>
  */
-export const useTextAlignProp = (val) =>
-  val === 'justified' ? 'justified' : useValueAndKey(val, 'aligned')
+export const getTextAlignProp = (val) =>
+  val === 'justified' ? 'justified' : getValueAndKey(val, 'aligned')
+
+/**
+ * @deprecated
+ */
+export const useTextAlignProp = getTextAlignProp
 
 /**
  * The "verticalAlign" prop follows the useValueAndKey.
@@ -99,7 +124,12 @@ export const useTextAlignProp = (val) =>
  * <Grid verticalAlign='middle' />
  * <div class="ui middle aligned grid"></div>
  */
-export const useVerticalAlignProp = (val) => useValueAndKey(val, 'aligned')
+export const getVerticalAlignProp = (val) => getValueAndKey(val, 'aligned')
+
+/**
+ * @deprecated
+ */
+export const useVerticalAlignProp = getVerticalAlignProp
 
 /**
  * Create "X", "X wide" and "equal width" classNames.
@@ -122,7 +152,7 @@ export const useVerticalAlignProp = (val) => useValueAndKey(val, 'aligned')
  * <Grid columns={4} />
  * <div class="ui four column grid"></div>
  */
-export const useWidthProp = (val, widthClass = '', canEqual = false) => {
+export const getWidthProp = (val, widthClass = '', canEqual = false) => {
   if (canEqual && val === 'equal') {
     return 'equal width'
   }
@@ -132,3 +162,8 @@ export const useWidthProp = (val, widthClass = '', canEqual = false) => {
   }
   return numberToWord(val)
 }
+
+/**
+ * @deprecated
+ */
+export const useWidthProp = getWidthProp