docs(clayui.com): LPD-46156 Add API documentation

liferay · Jan 23, 2025 · 28358b8 · 28358b8
1 parent b01f5e4
commit 28358b8
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/packages/clay-core/docs/api-language-picker.mdx b/packages/clay-core/docs/api-language-picker.mdx
@@ -0,0 +1,9 @@
+---
+title: 'Language Picker'
+description: 'A language picker is very similar to a dropdown visually but it let users select languages from the panel and then represent the selection in the button.'
+mainTabURL: 'docs/components/language-picker.html'
+---
+
+## Language Picker
+
+<div>[APITable "clay-core/src/language-picker/index.tsx"]</div>
diff --git a/packages/clay-core/src/language-picker/index.tsx b/packages/clay-core/src/language-picker/index.tsx
@@ -75,12 +75,12 @@ type Props = {
 	id?: string;
 
 	/**
-	 * Messages for the component
+	 * Messages for the component.
 	 */
 	messages?: Messages;
 
 	/**
-	 * List of locales to allow localization for
+	 * List of locales to allow localization for.
 	 */
 	locales: Array<Item>;
 
@@ -90,12 +90,12 @@ type Props = {
 	onActiveChange?: InternalDispatch<boolean>;
 
 	/**
-	 * Callback that gets called when a selected locale gets changed
+	 * Callback that gets called when a selected locale gets changed.
 	 */
 	onSelectedLocaleChange?: InternalDispatch<React.Key>;
 
 	/**
-	 * Exposes the currently selected locale id
+	 * Exposes the currently selected locale id (controlled).
 	 */
 	selectedLocaleId?: React.Key;
 
@@ -110,7 +110,7 @@ type Props = {
 	spritemap?: string;
 
 	/**
-	 * Translations provided to the component to be used and modified by it
+	 * Translations provided to the component to display the translation language status.
 	 */
 	translations?: Translations;
 };