Skip to content

Commit 7ab484d

Browse files
mwistrandmwistrand
authored
README Updates (dojo#568)
Update references to `@dojo/widget-core` to `@dojo/framework/widget-core` and change "Dojo 2" to "Dojo".
1 parent a1613e9 commit 7ab484d

File tree

26 files changed

+33
-33
lines changed

26 files changed

+33
-33
lines changed

‎README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
[![codecov](https://codecov.io/gh/dojo/widgets/branch/master/graph/badge.svg)](https://codecov.io/gh/dojo/widgets)
55
[![npm version](https://badge.fury.io/js/%40dojo%2Fwidgets.svg)](https://badge.fury.io/js/%40dojo%2Fwidgets)
66

7-
A suite of pre-built Dojo 2 widgets, ready to use in your web application.
8-
These widgets are built using Dojo 2's widget authoring system [(@dojo/widget-core)](https://github.com/dojo/widget-core).
7+
A suite of pre-built Dojo widgets, ready to use in your web application.
8+
These widgets are built using Dojo's widget authoring system [(@dojo/framework/widget-core)](https://github.com/dojo/framework/blob/master/src/widget-core/README.md).
99

1010
- [Usage](#usage)
1111
- [Features](#features)
@@ -155,22 +155,22 @@ The range definitions are as follows:
155155

156156
## How to customize a widget
157157

158-
There are many ways in which you can customize the behavior and appearance of Dojo 2 widgets.
159-
See the [`widget-core`](https://github.com/dojo/widget-core) README for examples of how to customize the theme or a specific CSS class of a widget.
158+
There are many ways in which you can customize the behavior and appearance of Dojo widgets.
159+
See the [`widget-core`](https://github.com/dojo/framework/blob/master/src/widget-core/README.md) README for examples of how to customize the theme or a specific CSS class of a widget.
160160

161161
Or can you write your own widget that extends an official widget.
162162

163163
### Extending widgets
164164

165-
Because all Dojo 2 widgets are Classes, you can simply extend the Class to add or change its behavior.
165+
Because all Dojo widgets are Classes, you can simply extend the Class to add or change its behavior.
166166

167167
```ts
168168
export class MyWidget extends Button {
169169
...
170170
}
171171
```
172172

173-
Dojo 2 widgets provide standard extension points to allow you to customize their behavior. For more details, please refer to the [widget authoring system](https://github.com/dojo/widget-core#decorator-lifecycle-hooks).
173+
Dojo widgets provide standard extension points to allow you to customize their behavior. For more details, please refer to the [widget authoring system](https://github.com/dojo/framework/blob/master/src/widget-core/README.md#decorator-lifecycle-hooks).
174174

175175
Individual widgets also provide certain types of extension points where applicable:
176176
- `render*`: Large render functions are split up into multiple smaller pieces that can be more easily overridden to create custom vdom.
@@ -180,7 +180,7 @@ Not all widgets include these extension points, and some have additional overrid
180180

181181
## How do I contribute?
182182

183-
We appreciate your interest! Please see the [Dojo 2 Meta Repository](https://github.com/dojo/meta#readme) for the
183+
We appreciate your interest! Please see the [Dojo Meta Repository](https://github.com/dojo/meta#readme) for the
184184
Contributing Guidelines and Style Guide.
185185

186186
### Installation
@@ -213,7 +213,7 @@ or
213213

214214
### Viewing widget examples locally
215215

216-
Each Dojo 2 widget includes functioning example code so you can view the widget. To view individual widget example:
216+
Each Dojo widget includes functioning example code so you can view the widget. To view individual widget example:
217217

218218
1. Run `grunt dev` in your terminal
219219
2. Open the newly built file `_build/common/example/index.html` in your web browser

‎intern.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"capabilities+": {
3-
"project": "Dojo 2",
3+
"project": "Dojo",
44
"name": "@dojo/widgets",
55
"browserstack.debug": false
66
},

‎src/accordion-pane/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/accordion-pane widget
22

3-
Dojo 2's `AccordionPane` component can be used to show multiple pieces of content inside collapsible panes within a common parent component. It provides a mechanism of control over multiple child `TitlePane` components.
3+
Dojo's `AccordionPane` component can be used to show multiple pieces of content inside collapsible panes within a common parent component. It provides a mechanism of control over multiple child `TitlePane` components.
44

55
## Features
66

‎src/button/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/button widget
22

3-
Dojo 2's `Button` widget creates a `<button>` element
3+
Dojo's `Button` widget creates a `<button>` element
44

55

66
## Features

‎src/calendar/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# @dojo/widgets/calendar widget
2-
Dojo 2's `Calendar` renders a date grid with a dropdown month and year picker. The displayed month and year are controlled via properties, defaulting to the current day. Given the limitations of scaling date grid while maintaining usability, the calendar is not fully responsive at small screen sizes; it is instead recommended to switch to an alternative date picker for mobile.
2+
Dojo's `Calendar` renders a date grid with a dropdown month and year picker. The displayed month and year are controlled via properties, defaulting to the current day. Given the limitations of scaling date grid while maintaining usability, the calendar is not fully responsive at small screen sizes; it is instead recommended to switch to an alternative date picker for mobile.
33

44
## Features
55

‎src/checkbox/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/checkbox widget
22

3-
Dojo 2's `Checkbox` widget provides either a wrapped, styleable checkbox widget or an on/off toggle. Both the normal and toggle `Checkbox` modes use the native `<input type="checkbox">` as a base.
3+
Dojo's `Checkbox` widget provides either a wrapped, styleable checkbox widget or an on/off toggle. Both the normal and toggle `Checkbox` modes use the native `<input type="checkbox">` as a base.
44

55

66
## Features

‎src/combobox/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/combobox widget
22

3-
Dojo 2's `ComboBox` widget provides a form control that allows users to either enter a value manually or to select a value from a list of results.
3+
Dojo's `ComboBox` widget provides a form control that allows users to either enter a value manually or to select a value from a list of results.
44

55
## Features
66

‎src/dialog/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/dialog widget
22

3-
Dojo 2's `Dialog` component can be used to show content inside a window over top the application content. It provides default styling for a titlebar, content area, underlay, and a close button.
3+
Dojo's `Dialog` component can be used to show content inside a window over top the application content. It provides default styling for a titlebar, content area, underlay, and a close button.
44

55
## Features
66

‎src/enhanced-text-input/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/enhanced-text-input widget
22

3-
Dojo 2's `EnhancedTextInput` widget extends `TextInput` to provide optional addons before or after the input, similar to those in [bootstrap](https://v4-alpha.getbootstrap.com/components/input-group/#basic-example).
3+
Dojo's `EnhancedTextInput` widget extends `TextInput` to provide optional addons before or after the input, similar to those in [bootstrap](https://v4-alpha.getbootstrap.com/components/input-group/#basic-example).
44

55

66
## Features

‎src/global-event/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/global-event widget
22

3-
Dojo 2's `GlobalEvent` enables events to be registered on `document` and `window` reactively.
3+
Dojo's `GlobalEvent` enables events to be registered on `document` and `window` reactively.
44

55
## Features
66

‎src/icon/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/icon widget
22

3-
Dojo 2's `Icon` widget renders an icon.
3+
Dojo's `Icon` widget renders an icon.
44

55

66
## Example Usage

‎src/label/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/label widget
22

3-
Dojo 2's `Label` widget creates a `<label>` element that wraps its children and inserts a text node as either the first or last child. It is included by default in all form input widgets, including `ComboBox` and `TimePicker`. Input widgets control the text, visibility, and placement of the label through the following properties:
3+
Dojo's `Label` widget creates a `<label>` element that wraps its children and inserts a text node as either the first or last child. It is included by default in all form input widgets, including `ComboBox` and `TimePicker`. Input widgets control the text, visibility, and placement of the label through the following properties:
44
- `label`: String used as label text
55
- `labelAfter`: If true, the label node follows the input node in the generated vdom
66
- `labelHidden`: This corresponds to the `hidden` class on the Label widget.

‎src/listbox/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/listbox widget
22

3-
Dojo 2's `Listbox` provides a base widget that can be used as an options menu within a `Select` or `ComboBox` component, or as a standalone multi-select component
3+
Dojo's `Listbox` provides a base widget that can be used as an options menu within a `Select` or `ComboBox` component, or as a standalone multi-select component
44

55
## Features
66

‎src/progress/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/progress widget
22

3-
Dojo 2's `progress` widget provides a themeable progress bar with a customizable output display.
3+
Dojo's `progress` widget provides a themeable progress bar with a customizable output display.
44

55

66
## Features

‎src/radio/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/radio widget
22

3-
Dojo 2's `Radio` widget provides a styleable radio widget with an optional label.
3+
Dojo's `Radio` widget provides a styleable radio widget with an optional label.
44

55

66
## Features

‎src/select/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/select widget
22

3-
Dojo 2's `Select` provides a dropdown menu form control using either the native `<select>` element or a fully custom component. The custom version uses the `Listbox` widget as its list of options.
3+
Dojo's `Select` provides a dropdown menu form control using either the native `<select>` element or a fully custom component. The custom version uses the `Listbox` widget as its list of options.
44

55
## Features
66

‎src/slide-pane/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/slide-pane widget
22

3-
Dojo 2's `SlidePane` widget provides a component capable of moving content into or out of the viewport, as is commonly used for mobile navigation menus.
3+
Dojo's `SlidePane` widget provides a component capable of moving content into or out of the viewport, as is commonly used for mobile navigation menus.
44

55

66
## Features

‎src/slider/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/slider widget
22

3-
Dojo 2's `Slider` widget creates a range slider control with a styleable track, fill, and draggable thumb control.
3+
Dojo's `Slider` widget creates a range slider control with a styleable track, fill, and draggable thumb control.
44

55

66
## Features

‎src/split-pane/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/split-pane widget
22

3-
Dojo 2's `SplitPane` component divides a container into two resizable panes that can oriented horizontally or vertically. It expects two child nodes.
3+
Dojo's `SplitPane` component divides a container into two resizable panes that can oriented horizontally or vertically. It expects two child nodes.
44

55
## Features
66

‎src/tab-controller/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/tab-controller widget
22

3-
Dojo 2's `TabController` widget provides a user interface capable of displaying tabbed content. The content shown at any given time is based on the currently-selected tab button.
3+
Dojo's `TabController` widget provides a user interface capable of displaying tabbed content. The content shown at any given time is based on the currently-selected tab button.
44

55
## Features
66

‎src/text-area/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/text-area widget
22

3-
Dojo 2's `Textarea` widget provides a wrapped native `textarea` input, optionally with a label.
3+
Dojo's `Textarea` widget provides a wrapped native `textarea` input, optionally with a label.
44

55

66
## Features

‎src/text-input/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/text-input widget
22

3-
Dojo 2's `TextInput` widget provides a basic text input widget with an optional label.
3+
Dojo's `TextInput` widget provides a basic text input widget with an optional label.
44

55

66
## Features

‎src/time-picker/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/time-picker widget
22

3-
Dojo 2's `TimePicker` widget provides a form control that allows users to manually enter a time or select a valid time from a dropdown of options. The non-native option wraps the `ComboBox` widget.
3+
Dojo's `TimePicker` widget provides a form control that allows users to manually enter a time or select a valid time from a dropdown of options. The non-native option wraps the `ComboBox` widget.
44

55
## Features
66

‎src/title-pane/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/title-pane widget
22

3-
Dojo 2's `TitlePane` component can be used to display content inside a window with a titlebar. When the titlebar is clicked, the content collapses. This component provides default styling for the titlebar, and content area, and will respond to different screen sizes responsively.
3+
Dojo's `TitlePane` component can be used to display content inside a window with a titlebar. When the titlebar is clicked, the content collapses. This component provides default styling for the titlebar, and content area, and will respond to different screen sizes responsively.
44

55
## Features
66

‎src/toolbar/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/toolbar widget
22

3-
Dojo 2's `Toolbar` component can be used to display an application navigation bar that can show a title and action items. Action elements can be configured to automatically collapse into a `SlidePane` component.
3+
Dojo's `Toolbar` component can be used to display an application navigation bar that can show a title and action items. Action elements can be configured to automatically collapse into a `SlidePane` component.
44

55
## Features
66

‎src/tooltip/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @dojo/widgets/tooltip widget
22

3-
Dojo 2's `Tooltip` component can be used to show or hide content around a child component based on specific events.
3+
Dojo's `Tooltip` component can be used to show or hide content around a child component based on specific events.
44

55
## Features
66

0 commit comments

Comments
 (0)