adding descriptions to the components - oseer (#2155)

Teradata · May 1, 2024 · d1744ee · d1744ee
1 parent a13dbe7
commit d1744ee
Show file tree

Hide file tree

Showing 54 changed files with 192 additions and 173 deletions.
diff --git a/apps/knapsack/data/demos/demo.1OH1Dga5C0.json b/apps/knapsack/data/demos/demo.1OH1Dga5C0.json
@@ -28,38 +28,7 @@
           "demoId": "gMTyjmInaG"
         }
       ],
-      "status-header-text": [
-        {
-          "type": "template-demo",
-          "patternId": "status-header-item",
-          "templateId": "web-components-55FkYSafco",
-          "demoId": "YHuTizup8"
-        },
-        {
-          "type": "template-demo",
-          "patternId": "status-header-item",
-          "templateId": "web-components-55FkYSafco",
-          "demoId": "YHuTizup8"
-        },
-        {
-          "type": "template-demo",
-          "patternId": "status-header-item",
-          "templateId": "web-components-55FkYSafco",
-          "demoId": "YHuTizup8"
-        },
-        {
-          "type": "template-demo",
-          "patternId": "status-header-item",
-          "templateId": "web-components-55FkYSafco",
-          "demoId": "YHuTizup8"
-        },
-        {
-          "type": "template-demo",
-          "patternId": "status-header-item",
-          "templateId": "web-components-55FkYSafco",
-          "demoId": "YHuTizup8"
-        }
-      ]
+      "status-header-text": []
     }
   }
 }
diff --git a/apps/knapsack/data/demos/demo.V0duRbXK9s.json b/apps/knapsack/data/demos/demo.V0duRbXK9s.json
diff --git a/apps/knapsack/data/demos/demo.b7gHexlITw.json b/apps/knapsack/data/demos/demo.b7gHexlITw.json
diff --git a/apps/knapsack/data/demos/demo.l5OMMCwUDB.json b/apps/knapsack/data/demos/demo.l5OMMCwUDB.json
diff --git a/apps/knapsack/data/knapsack.navs.yml b/apps/knapsack/data/knapsack.navs.yml
@@ -253,7 +253,7 @@ byId:
   tab:
     hidden: true
     id: tab
-    name: tab
+    name: Tab item
     parentId: tabs
     path: /pattern/tab
   tabs:

diff --git a/apps/knapsack/data/knapsack.pattern.action-ribbon.json b/apps/knapsack/data/knapsack.pattern.action-ribbon.json
@@ -3,7 +3,7 @@
   "title": "Action ribbon",
   "description": "Provide a common, dynamic region for user actions and feedback which applies to a subset of the UI.",
   "statuses": {
-    "main": "draft"
+    "main": "needsReview"
   },
   "templates": [
     {

diff --git a/apps/knapsack/data/knapsack.pattern.alert.json b/apps/knapsack/data/knapsack.pattern.alert.json
@@ -1,8 +1,10 @@
 {
   "id": "alert",
   "title": "Alert",
-  "description": "",
-  "statuses": {},
+  "description": "Notification informing users about important information or events.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-4qjJYWsUZi",

diff --git a/apps/knapsack/data/knapsack.pattern.app-shell.json b/apps/knapsack/data/knapsack.pattern.app-shell.json
@@ -1,8 +1,10 @@
 {
   "id": "app-shell",
   "title": "App shell",
-  "description": "",
-  "statuses": {},
+  "description": "The structural foundation of an application, including its layout and navigation.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-z8r4uoVkf",

diff --git a/apps/knapsack/data/knapsack.pattern.badge.json b/apps/knapsack/data/knapsack.pattern.badge.json
@@ -1,8 +1,10 @@
 {
   "id": "badge",
   "title": "Badge",
-  "description": "",
-  "statuses": {},
+  "description": "A small visual element indicating status or providing additional information.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-40aOlYC6I9",

diff --git a/apps/knapsack/data/knapsack.pattern.breadcrumbs.json b/apps/knapsack/data/knapsack.pattern.breadcrumbs.json
@@ -1,8 +1,10 @@
 {
   "id": "breadcrumbs",
   "title": "Breadcrumbs",
-  "description": "",
-  "statuses": {},
+  "description": "Navigation aid displaying the user's location within a website or application hierarchy.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [],
   "tabs": [
     {

diff --git a/apps/knapsack/data/knapsack.pattern.button.json b/apps/knapsack/data/knapsack.pattern.button.json
@@ -3,7 +3,7 @@
   "title": "Button",
   "description": "Common buttons prompt most actions in a UI",
   "statuses": {
-    "main": "needsDev"
+    "main": "needsReview"
   },
   "templates": [
     {

diff --git a/apps/knapsack/data/knapsack.pattern.card.json b/apps/knapsack/data/knapsack.pattern.card.json
@@ -1,8 +1,10 @@
 {
   "id": "card",
   "title": "Card",
-  "description": "",
-  "statuses": {},
+  "description": "Container presenting information or content in a visually distinct format.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-mU8MX1FHrF",

diff --git a/apps/knapsack/data/knapsack.pattern.check-list-item.json b/apps/knapsack/data/knapsack.pattern.check-list-item.json
@@ -1,8 +1,10 @@
 {
   "id": "check-list-item",
   "title": "Check list item",
-  "description": "",
-  "statuses": {},
+  "description": "An item in a list that users can mark as completed or incomplete.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-M18BFFHM3h",

diff --git a/apps/knapsack/data/knapsack.pattern.checkbox.json b/apps/knapsack/data/knapsack.pattern.checkbox.json
@@ -1,8 +1,10 @@
 {
   "id": "checkbox",
   "title": "Checkbox",
-  "description": "",
-  "statuses": {},
+  "description": "Interactive element allowing users to select one or more options from a list.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-29FbeDQWhM",

diff --git a/apps/knapsack/data/knapsack.pattern.chip-item.json b/apps/knapsack/data/knapsack.pattern.chip-item.json
@@ -1,8 +1,10 @@
 {
   "id": "chip-item",
   "title": "Chip item",
-  "description": "",
-  "statuses": {},
+  "description": "Individual item within a chip list.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-vegaZgkE47",

diff --git a/apps/knapsack/data/knapsack.pattern.chip.json b/apps/knapsack/data/knapsack.pattern.chip.json
@@ -1,8 +1,10 @@
 {
   "id": "chip",
   "title": "Chip",
-  "description": "",
-  "statuses": {},
+  "description": "Compact visual element representing an attribute, action, or choice.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-7wYRPSnEZH",

diff --git a/apps/knapsack/data/knapsack.pattern.circular-progress.json b/apps/knapsack/data/knapsack.pattern.circular-progress.json
@@ -57,5 +57,9 @@
       "id": "kWQoZ3d4QL",
       "blockIds": []
     }
-  ]
+  ],
+  "description": "Visual indication of progress displayed in a circular format.",
+  "statuses": {
+    "main": "needsReview"
+  }
 }
diff --git a/apps/knapsack/data/knapsack.pattern.code-snippet.json b/apps/knapsack/data/knapsack.pattern.code-snippet.json
@@ -1,8 +1,10 @@
 {
   "id": "code-snippet",
   "title": "Code snippet",
-  "description": "",
-  "statuses": {},
+  "description": "Portion of code displayed within an interface, often for demonstration or explanation.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-MmKtwF24Vv",

diff --git a/apps/knapsack/data/knapsack.pattern.dialog.json b/apps/knapsack/data/knapsack.pattern.dialog.json
@@ -1,8 +1,10 @@
 {
   "id": "dialog",
   "title": "Dialog",
-  "description": "",
-  "statuses": {},
+  "description": "Modal window prompting users for input or displaying critical information.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-S9Ia0KOrya",

diff --git a/apps/knapsack/data/knapsack.pattern.empty-state.json b/apps/knapsack/data/knapsack.pattern.empty-state.json
@@ -1,8 +1,10 @@
 {
   "id": "empty-state",
   "title": "Empty state",
-  "description": "",
-  "statuses": {},
+  "description": "Placeholder content displayed when there is no data to show.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-E0GwXgHJv",

diff --git a/apps/knapsack/data/knapsack.pattern.expansion-panel-item.json b/apps/knapsack/data/knapsack.pattern.expansion-panel-item.json
@@ -1,8 +1,10 @@
 {
   "id": "expansion-panel-item",
   "title": "Expansion panel item",
-  "description": "",
-  "statuses": {},
+  "description": "Individual item within an expansion panel.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-vBLifAApG",

diff --git a/apps/knapsack/data/knapsack.pattern.expansion-panel.json b/apps/knapsack/data/knapsack.pattern.expansion-panel.json
@@ -1,8 +1,10 @@
 {
   "id": "expansion-panel",
   "title": "Expansion panel",
-  "description": "",
-  "statuses": {},
+  "description": "Collapsible panel revealing additional content when expanded.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-Vj98q2D8hw",

diff --git a/apps/knapsack/data/knapsack.pattern.form-field.json b/apps/knapsack/data/knapsack.pattern.form-field.json
@@ -1,8 +1,10 @@
 {
   "id": "form-field",
   "title": "Form Field",
-  "description": "",
-  "statuses": {},
+  "description": "Input field within a form for users to enter data.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-I5Sx1HQnJ",

diff --git a/apps/knapsack/data/knapsack.pattern.icon-button-toggle.json b/apps/knapsack/data/knapsack.pattern.icon-button-toggle.json
@@ -1,8 +1,10 @@
 {
   "id": "icon-button-toggle",
   "title": "Icon button toggle",
-  "description": "",
-  "statuses": {},
+  "description": "Toggle button featuring an icon as the visual indicator of its state.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-6kGMXrj-eP",

diff --git a/apps/knapsack/data/knapsack.pattern.icon-button.json b/apps/knapsack/data/knapsack.pattern.icon-button.json
@@ -1,8 +1,10 @@
 {
   "id": "icon-button",
   "title": "Icon button",
-  "description": "",
-  "statuses": {},
+  "description": "Button with an icon as the primary visual element.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-ctiCe2sAX",

diff --git a/apps/knapsack/data/knapsack.pattern.icon-checkbox.json b/apps/knapsack/data/knapsack.pattern.icon-checkbox.json
@@ -1,8 +1,10 @@
 {
   "id": "icon-checkbox",
   "title": "Icon checkbox",
-  "description": "",
-  "statuses": {},
+  "description": "Checkbox styled with an icon as its visual representation.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-jTiv8OpG9M",

diff --git a/apps/knapsack/data/knapsack.pattern.icon-radio.json b/apps/knapsack/data/knapsack.pattern.icon-radio.json
@@ -1,8 +1,10 @@
 {
   "id": "icon-radio",
   "title": "Icon radio",
-  "description": "",
-  "statuses": {},
+  "description": "Radio button styled with an icon as its visual representation.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-gmBL6Mhy4",

diff --git a/apps/knapsack/data/knapsack.pattern.icon.json b/apps/knapsack/data/knapsack.pattern.icon.json
@@ -1,8 +1,10 @@
 {
   "id": "icon",
   "title": "Icon",
-  "description": "",
-  "statuses": {},
+  "description": "Symbol representing an action, object, or concept.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-N8bzRbfpuX",

diff --git a/apps/knapsack/data/knapsack.pattern.linear-progress.json b/apps/knapsack/data/knapsack.pattern.linear-progress.json
@@ -1,8 +1,10 @@
 {
   "id": "linear-progress",
   "title": "Linear progress",
-  "description": "",
-  "statuses": {},
+  "description": "Visual indication of progress displayed in a linear format.",
+  "statuses": {
+    "main": "needsReview"
+  },
   "templates": [
     {
       "id": "web-components-2ew8-hMQkv",