Merge pull request #7 from bitcoin3us/docs/settings-ui-options-labels

SettingsActivity: document ui_options label mapping for value-label row

Author: ThomasFarstrike

docs/frameworks/setting-activity.md

@@ -39,7 +39,7 @@ Each setting is defined as a dictionary with the following properties:
 
 ### Optional Properties
 - **`ui`** (string): UI type to use for editing. Options: `"textarea"` (default), `"radiobuttons"`, `"dropdown"`, `"slider"`, `"activity"`
-- **`ui_options`** (list): Options for `radiobuttons` and `dropdown` UI types
+- **`ui_options`** (list): Options for `radiobuttons` and `dropdown` UI types. Each entry is a `(label, value)` tuple — the **label** appears on the radio button or dropdown row AND in the parent `SettingsActivity`'s value-label row beneath the title. The **value** is what gets stored in SharedPreferences. See [SettingsActivity → Display Labels for `ui_options`](settings-activity.md#display-labels-for-ui_options) for details.
 - **`placeholder`** (string): Placeholder text for textarea input
 - **`default_value`** (string): Default value to select or fill in
 - **`changed_callback`** (function): Callback function called when the setting value changes

docs/frameworks/settings-activity.md

@@ -36,7 +36,7 @@ class MyApp(Activity):
 
 ### Optional Properties
 - **`ui`** (string): UI type for editing. Options: `"textarea"` (default), `"radiobuttons"`, `"dropdown"`, `"slider"`, `"activity"`
-- **`ui_options`** (list): Options for `radiobuttons` and `dropdown` UI types
+- **`ui_options`** (list): Options for `radiobuttons` and `dropdown` UI types. Each entry is a `(label, value)` tuple — the **label** is shown in the picker AND in the row's value label below the title; the **value** is what gets stored in SharedPreferences. See [Display Labels for `ui_options`](#display-labels-for-ui_options) below.
 - **`placeholder`** (string): Placeholder text for textarea input
 - **`changed_callback`** (function): Callback function called when the setting value changes
 - **`should_show`** (function): Boolean or function to determine if this setting should be displayed in the list
@@ -132,6 +132,28 @@ Use a custom Activity class for advanced UI implementations.
 }
 ```
 
+## Display Labels for `ui_options`
+
+For `radiobuttons` and `dropdown` settings, each entry in `ui_options` is a `(label, value)` tuple:
+
+```python
+"ui_options": [
+    ("Lightning Piggy", "lightningpiggy"),    # ← label  ← stored value
+    ("Lightning Penguin", "lightningpenguin"),
+    ("None", "none"),
+]
+```
+
+The settings-list row beneath each setting's title shows the **label** corresponding to the current stored value — not the raw value. So a row whose stored value is `"lightningpiggy"` displays "Lightning Piggy" below the title, matching what the user picked in the picker. This applies both on initial render and after a save.
+
+If the stored value isn't present in the current `ui_options` list (e.g. a stale pref from before the option set changed), the raw value is shown unchanged rather than collapsing to "(not set)" — so the user can still see and recover from a now-invalid value.
+
+Tips for choosing labels and values:
+
+- **Labels** should be human-readable with spaces, casing, and punctuation as you want them shown to the user ("Lightning Piggy", not "lightningpiggy").
+- **Values** should be machine-friendly identifiers — short, no spaces, stable across releases. They appear in SharedPreferences and in any export/import flows, so keep them URL-safe and ASCII when possible.
+- **Don't change values for existing options** without a migration. The label can change freely (it's a presentation concern); the value is the identity.
+
 ## Advanced Features
 
 ### Conditional Visibility with should_show