From 5445445136650935c4f4abf3341cf3ef3c32716d Mon Sep 17 00:00:00 2001 From: Matt Bruce Date: Mon, 28 Nov 2022 14:29:09 -0600 Subject: [PATCH] added documentation Signed-off-by: Matt Bruce --- VDS/Components/Badge/Badge.swift | 2 ++ VDS/Components/Checkbox/Checkbox.swift | 1 + VDS/Components/Label/Label.swift | 5 +---- VDS/VDS.docc/VDS.md | 21 +++++++++++++++++---- 4 files changed, 21 insertions(+), 8 deletions(-) diff --git a/VDS/Components/Badge/Badge.swift b/VDS/Components/Badge/Badge.swift index e61f11a9..9541a483 100644 --- a/VDS/Components/Badge/Badge.swift +++ b/VDS/Components/Badge/Badge.swift @@ -15,6 +15,8 @@ public enum BadgeFillColor: String, Codable, CaseIterable { case red, yellow, green, orange, blue, black, white } + +/// Badges are visual labels used to convey status or highlight supplemental information. @objc(VDSBadge) public class Badge: View, Accessable { diff --git a/VDS/Components/Checkbox/Checkbox.swift b/VDS/Components/Checkbox/Checkbox.swift index 22ff909b..21e31c9b 100644 --- a/VDS/Components/Checkbox/Checkbox.swift +++ b/VDS/Components/Checkbox/Checkbox.swift @@ -11,6 +11,7 @@ import VDSColorTokens import VDSFormControlsTokens import Combine +/// Checkboxes are a multi-select component through which a customer indicates a choice. If a binary choice, the component is a checkbox. If the choice has multiple options, the component is a ``CheckboxGroup``. @objc(VDSCheckbox) public class Checkbox: CheckboxBase{} diff --git a/VDS/Components/Label/Label.swift b/VDS/Components/Label/Label.swift index 7fcc931e..b1e9256f 100644 --- a/VDS/Components/Label/Label.swift +++ b/VDS/Components/Label/Label.swift @@ -11,10 +11,7 @@ import VDSColorTokens import Combine @objc(VDSLabel) -public class Label: LabelBase {} - -@objc(VDSLabelBase) -open class LabelBase: UILabel, Handlerable, ViewProtocol, Resettable { +public class Label: UILabel, Handlerable, ViewProtocol, Resettable { //-------------------------------------------------- // MARK: - Combine Properties diff --git a/VDS/VDS.docc/VDS.md b/VDS/VDS.docc/VDS.md index 27aecc21..0cf1e32e 100755 --- a/VDS/VDS.docc/VDS.md +++ b/VDS/VDS.docc/VDS.md @@ -1,13 +1,26 @@ # ``VDS`` -Summary +The Verizon Design System is the single source of truth for Verizon’s digital experiences. It aligns design and code resources to give designers and developers consistent, detailed documentation and standardized libraries of symbols and coded components. ## Overview -Text +Using the system allows designers and developers to collaborate more easily and efficiently on creating on-brand and accessible digital experiences. Spend more time improving our digital products for customers and less time redrawing or rebuilding basic user interface elements. ## Topics -### Group +### Components -- ``Symbol`` \ No newline at end of file +- ``Badge`` +- ``Button`` +- ``TextLink`` +- ``TextLinkCaret`` +- ``CheckboxGroup`` +- ``Checkbox`` +- ``Label`` +- ``RadioBoxGroup`` +- ``RadioBox`` +- ``RadioButtonGroup`` +- ``RadioButton`` +- ``RadioSwatchGroup`` +- ``RadioSwatch`` +- ``Toggle``