@wikimedia/codex - npm Package Compare versions

Comparing version 0.6.1 to 0.6.2

dist/types/components/button-group/ButtonGroup.vue.d.ts

@@ -5,3 +5,3 @@ import { PropType } from 'vue';
 /**
- * Set of actions made up of two or more buttons.
+ * A set of two or more buttons representing related actions.
  *
@@ -8,0 +8,0 @@ * Buttons in this button group signal a number of equally important actions that will occur when

dist/types/components/button/Button.vue.d.ts

 import { PropType } from 'vue';
 /**
- * A button wrapping slotted content.
+ * A control that can be pressed to trigger an action.
  */
@@ -5,0 +5,0 @@ declare const _default: import("vue").DefineComponent<{

dist/types/components/card/Card.vue.d.ts

@@ -5,3 +5,3 @@ import { PropType } from 'vue';
 /**
- * A structural component used to group information and actions related to a single topic.
+ * A set of information and actions related to a single topic.
  */
@@ -8,0 +8,0 @@ declare const _default: import("vue").DefineComponent<{

dist/types/components/checkbox/Checkbox.vue.d.ts

 import { PropType } from 'vue';
 /**
- * A binary input that can exist by itself or in a group. When in a group, any
- * number of checkboxes can be checked at a time.
+ * A binary input that can be standalone or in a multiselect group.
  *
+ * When in a group, any number of checkboxes can be checked at a time.
+ *
  * Typical use will involve using `v-for` to loop through an array of items and
@@ -7,0 +8,0 @@ * output a Checkbox component for each one. Each Checkbox will have the same

dist/types/components/combobox/Combobox.vue.d.ts

 import { PropType } from 'vue';
 import { MenuItemData, MenuConfig } from '../../types';
 /**
- * Text input with an adjoining button and an expandable menu of items.
+ * A text input with an expandable menu of predefined items.
  */
@@ -75,3 +75,7 @@ declare const _default: import("vue").DefineComponent<{
                 validator: import("../../types").StringTypeValidator<"default" | "error">;
-            };
+            }; /**
+             * Configuration for various menu features. All properties default to false.
+             *
+             * See the MenuConfig type.
+             */
             disabled: {
@@ -128,3 +132,7 @@ type: BooleanConstructor;
                 validator: import("../../types").StringTypeValidator<"default" | "error">;
-            };
+            }; /**
+             * Configuration for various menu features. All properties default to false.
+             *
+             * See the MenuConfig type.
+             */
             disabled: {
@@ -215,3 +223,7 @@ type: BooleanConstructor;
             validator: import("../../types").StringTypeValidator<"default" | "error">;
-        };
+        }; /**
+         * Configuration for various menu features. All properties default to false.
+         *
+         * See the MenuConfig type.
+         */
         disabled: {
@@ -218,0 +230,0 @@ type: BooleanConstructor;

dist/types/components/icon/Icon.vue.d.ts

 import { PropType } from 'vue';
 import { Icon } from '@wikimedia/codex-icons';
 import { HTMLDirection } from '../../types';
+/**
+ * A graphical representation of an idea.
+ */
 declare const _default: import("vue").DefineComponent<{
@@ -5,0 +8,0 @@ /** The SVG path or an object containing that path plus other data. */

dist/types/components/info-chip/InfoChip.vue.d.ts

 import { PropType } from 'vue';
 import { Icon } from '@wikimedia/codex-icons';
 /**
- * A chip wrapping slotted content.
+ * A non-interactive chip that provides information.
  */
@@ -6,0 +6,0 @@ declare const _default: import("vue").DefineComponent<{

dist/types/components/lookup/Lookup.vue.d.ts

 import { PropType } from 'vue';
 import { MenuItemData, MenuConfig } from '../../types';
 /**
- * Text input with a dropdown menu of items, which are usually based on the current input value.
+ * A predictive text input with a dropdown menu of items.
  *
@@ -6,0 +6,0 @@ * Typical use will involve listening for `input` events, fetching or otherwise computing menu

dist/types/components/menu-item/MenuItem.vue.d.ts

@@ -5,3 +5,3 @@ import { PropType } from 'vue';
 /**
- * Item within a Menu component.
+ * A selectable option included within a Menu.
  *
@@ -8,0 +8,0 @@ * A value must be provided, and various optional elements can be displayed:

dist/types/components/menu/Menu.vue.d.ts

 import { PropType, ComponentPublicInstance } from 'vue';
 import { MenuItemData, MenuItemDataWithId, MenuState } from '../../types';
 /**
- * Dropdown menu of items.
+ * A contextual list of selectable options, often triggered by a control or an input.
  *
@@ -6,0 +6,0 @@ * Designed for use in components, like Select and Lookup, that display a menu below another element

dist/types/components/message/Message.vue.d.ts

 import { PropType } from 'vue';
 import { Icon } from '@wikimedia/codex-icons';
 /**
- * User-facing message with icon.
+ * System feedback in response to or to inform a user action.
  *
@@ -6,0 +6,0 @@ * Message styles and icon will vary depending on the message type (notice, warning, error or

dist/types/components/progress-bar/ProgressBar.vue.d.ts

 /**
- * Visual progress indicator bar.
+ * A linear indicator of progress.
  *
@@ -4,0 +4,0 @@ * Currently only supports indeterminate type (i.e. the bar will scroll across the width of the

dist/types/components/radio/Radio.vue.d.ts

 /**
- * A binary input that always exists in a group, in which only one input can be on at a time.
+ * A binary input, part of a single-select group.
  *
@@ -4,0 +4,0 @@ * Typical use will involve using `v-for` to loop through an array of items and output a Radio

dist/types/components/search-input/SearchInput.vue.d.ts

 import { PropType } from 'vue';
 /**
- * Search input with optional button.
+ * An input for text search.
  *
@@ -5,0 +5,0 @@ * This component contains a TextInput component with a preset start icon and input type. A button

dist/types/components/select/Select.vue.d.ts

@@ -5,3 +5,3 @@ import { PropType } from 'vue';
 /**
- * A dropdown menu similar to the HTML `<select>` element.
+ * An input with a dropdown menu of predefined selectable items.
  *
@@ -8,0 +8,0 @@ * Menu items are provided as an array of MenuItemData types, and `v-model` is used

dist/types/components/tab/Tab.vue.d.ts

 import { TabData } from '../../types';
 /**
- * A component representing a section within a tabbed layout.
+ * A section of content within a Tabs layout.
+ *
  * This component can display arbitrary content via its default slot.
@@ -5,0 +6,0 @@ * Provided markup is wrapped inside of a `<section>` tag and given

dist/types/components/tabs/Tabs.vue.d.ts

 import { ComponentPublicInstance } from 'vue';
 import { TabData } from '../../types';
 /**
- * A layout containing multiple sections, only one of which is visible at any
- * given time. A header row is automatically generated from the provided
- * content.
+ * A layout for navigating between sections of content.
  *
@@ -8,0 +6,0 @@ * One or more `<Tab>` components must be provided in the default slot of the

dist/types/components/text-input/TextInput.vue.d.ts

 import { PropType } from 'vue';
 import { Icon } from '@wikimedia/codex-icons';
 /**
- * HTML `<input>` element with type "text" or "search", wrapped in a `<div>`.
+ * A form element that lets users input and edit a single-line text value.
  *
@@ -6,0 +6,0 @@ * `v-model` is used to track the current value of the input. See the events docs for details on

dist/types/components/thumbnail/Thumbnail.vue.d.ts

@@ -5,3 +5,3 @@ import { PropType } from 'vue';
 /**
- * Thumbnail background image or placeholder icon.
+ * A small preview of an image.
  *
@@ -8,0 +8,0 @@ * The placeholder icon will display until thumbnail image loads, or if a thumbnail image is not

dist/types/components/toggle-button-group/ToggleButtonGroup.vue.d.ts

@@ -5,3 +5,3 @@ import { PropType } from 'vue';
 /**
- * Group of toggle buttons that allows making a selection.
+ * A group of toggle buttons for making a selection.
  *
@@ -8,0 +8,0 @@ * Single-select groups behave like a group of radio buttons: only one value can be selected,

dist/types/components/toggle-button/ToggleButton.vue.d.ts

 /**
- * A toggle button wrapping slotted content.
+ * A button that can be toggled on and off.
  *
@@ -4,0 +4,0 @@ * You should always include some content to display on the button via the default slot.

dist/types/components/toggle-switch/ToggleSwitch.vue.d.ts

 /**
- * A checkbox input styled to look like a sliding on/off switch.
+ * A sliding boolean input used to enable or disable options.
  *
@@ -4,0 +4,0 @@ * Unlike Checkbox, ToggleSwitch is meant to be used alone, not in a group.

dist/types/components/typeahead-search/TypeaheadSearch.vue.d.ts

 import { PropType } from 'vue';
 import { SearchResult, SearchResultWithId, MenuItemDataWithId, MenuConfig } from '../../types';
 /**
- * A search form with stylized autocomplete suggestions.
+ * A search form that provides a menu with autocomplete suggestions.
  *
@@ -132,2 +132,5 @@ * TypeaheadSearch contains a form with a text input, a submit button, and a slot for hidden inputs.
                 type: PropType<import("../../types").MenuItemData[]>;
+                /**
+                 * Label attribute for the list of search results.
+                 */
                 required: true;
@@ -198,2 +201,5 @@ };
                 type: PropType<import("../../types").MenuItemData[]>;
+                /**
+                 * Label attribute for the list of search results.
+                 */
                 required: true;
@@ -397,2 +403,5 @@ };
             type: PropType<import("../../types").MenuItemData[]>;
+            /**
+             * Label attribute for the list of search results.
+             */
             required: true;
@@ -399,0 +408,0 @@ };

package.json

 {
 	"name": "@wikimedia/codex",
-	"version": "0.6.1",
+	"version": "0.6.2",
 	"description": "Codex is a toolkit for building user interfaces within the Wikimedia Design System",
@@ -5,0 +5,0 @@ "keywords": [

No alert changes

Improved metrics

Total package byte prevSize

638201

0.12%

Lines of code

9826

0.24%

No dependency changes