Skip to content

Commit cfe4b42

Browse files
authored
chore: Update doc URLs in plugin readmes (#2622)
1 parent eacbc11 commit cfe4b42

File tree

5 files changed

+14
-16
lines changed

5 files changed

+14
-16
lines changed

plugins/field-colour-hsv-sliders/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ npm install @blockly/field-colour-hsv-sliders --save
2020

2121
## Usage
2222

23-
This plugin adds a field type `FieldColourHsvSliders` that is registered to the name `'field_colour_hsv_sliders'`. This field is an extension of the `Blockly.FieldColour` field and outputs values in the same hexadecimal string format `'#rrggbb'` even though the UI represents the colour in the HSV colour space. See the [Blockly.FieldColour documentation](https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/colour#creation) on what parameters and configurations this field supports, although unlike `Blockly.FieldColour`, this field does not use colour swatches and thus ignores options related to the swatches such as `'colourOptions'`.
23+
This plugin adds a field type `FieldColourHsvSliders` that is registered to the name `'field_colour_hsv_sliders'`. This field is an extension of the `Blockly.FieldColour` field and outputs values in the same hexadecimal string format `'#rrggbb'` even though the UI represents the colour in the HSV colour space. See the [Blockly.FieldColour documentation](https://www.npmjs.com/package/@blockly/field-colour#creation) on what parameters and configurations this field supports, although unlike `Blockly.FieldColour`, this field does not use colour swatches and thus ignores options related to the swatches such as `'colourOptions'`.
2424

2525
The UI also provides an eye dropper button that can be used to take a colour from anywhere on the screen [on supported platforms](https://caniuse.com/?search=eyedropper). Chrome, Edge, and Opera support the eye dropper feature, except [on Chromebooks](https://bugs.chromium.org/p/chromium/issues/detail?id=1348921) and on mobile devices. There is also [a known bug in Chrome on some versions of Linux](https://bugs.chromium.org/p/chromium/issues/detail?id=1227633) where the eye dropper may be visible but does not work correctly.
2626

plugins/field-colour/README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ Blockly.Extensions.register('set_colours_extension', function () {
189189
```
190190

191191
This is done using a JSON
192-
[extension](https://developers.google.com/blockly/guides/create-custom-blocks/extensions).
192+
[extension](https://developers.google.com/blockly/guides/create-custom-blocks/define/extensions).
193193

194194
#### JavaScript
195195

@@ -282,22 +282,20 @@ colourBlend.installBlock({
282282

283283
#### Message files and locales
284284

285-
The blocks in this package contain text that can be
286-
[localized](https://developers.google.com/blockly/guides/create-custom-blocks/localize-blocks)
287-
into multiple languages. As of August 2024, the relevant messages are
288-
included in the core Blockly language files.
285+
The blocks in this package contain text that can be localized into multiple
286+
languages. As of August 2024, the relevant messages are included in the core
287+
Blockly language files. For information on Blockly's approach to localization,
288+
see [Localization](https://developers.google.com/blockly/guides/configure/web/translations)
289+
in the developer's guide.
289290

290291
If your blocks show `%{BKY_COLOUR_BLEND_TITLE}` or similar text instead
291292
of the expected text, make sure that you either:
292293

293-
- Import the [default Blockly modules](https://developers.google.com/blockly/guides/configure/web/translations#import_blockly_default_modules),
294-
which includes the English langfiles, or
295-
- Explicitly [import a language](https://developers.google.com/blockly/guides/configure/web/translations#import_blockly_languages)
296-
and call `setLocale` before using these blocks.
294+
- Import the default Blockly modules, which includes the English langfiles, or
295+
- Explicitly import a language and call `setLocale` before using these blocks.
297296

298-
For more information on Blockly's approach to localization, see the
299-
[Localize Blocks](https://developers.google.com/blockly/guides/create-custom-blocks/localize-blocks)
300-
developer guide.
297+
For more information, see [Load a Blockly localization
298+
table](https://developers.google.com/blockly/guides/configure/web/translations#load-blockly).
301299

302300
### API Reference
303301

plugins/field-dependent-dropdown/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This plugin adds a field type `FieldDependentDropdown` that is an extension of `
2222

2323
These changes are recorded properly in the undo history, and the fields can be [serialized and later deserialized](https://developers.google.com/blockly/guides/configure/web/serialization) while preserving their options, values, and validity. You can also create chains of dependent dropdowns that depend on other dependent dropdowns.
2424

25-
Note that the parent field must be attached to the block before the child field, and the child field will attach a validator function to the parent field to intercept changes to its value. If you want to add your own [custom field validator](https://developers.google.com/blockly/guides/create-custom-blocks/fields/validators) to the parent field, you need to use [the JavaScript API to define your block](https://developers.google.com/blockly/guides/create-custom-blocks/define-blocks#json_format_versus_javascript_api) and [pass your validator to the parent field's constructor](https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/dropdown#creating_a_dropdown_validator). If you try to set the parent's validator later, you'll overwrite the one added by this plugin.
25+
Note that the parent field must be attached to the block before the child field, and the child field will attach a validator function to the parent field to intercept changes to its value. If you want to add your own [custom field validator](https://developers.google.com/blockly/guides/create-custom-blocks/fields/validators) to the parent field, you need to use [the JavaScript API to define your block](https://developers.google.com/blockly/guides/create-custom-blocks/define/json-and-js) and [pass your validator to the parent field's constructor](https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/dropdown#creating_a_dropdown_validator). If you try to set the parent's validator later, you'll overwrite the one added by this plugin.
2626

2727
To create a dependent dropdown, you'll need to add this field type to a block definition, and add that block to your toolbox. See below for an example of defining a block that uses this field.
2828

plugins/theme-modern/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# @blockly/theme-modern [![Built on Blockly](https://tinyurl.com/built-on-blockly)](https://github.com/google/blockly)
22

33
A [Blockly](https://www.npmjs.com/package/blockly) modern theme that uses the
4-
same block colours as the [Classic theme](https://github.com/google/blockly/blob/master/core/theme/classic.js)
4+
same block colours as the [Classic theme](https://github.com/google/blockly/blob/master/core/theme/classic.ts)
55
but with darker borders. This theme was designed to be used with the Thrasos or
66
Zelos renderer.
77

plugins/toolbox-search/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A [Blockly](https://www.npmjs.com/package/blockly) plugin that adds a toolbox category for searching
44
blocks. The category displays a search field in the toolbox, and filters the available blocks as you
5-
type. The Blockly docs have [more information about toolbox definitions and categories](https://developers.google.com/blockly/guides/configure/web/toolbox#categories).
5+
type. The Blockly docs have [more information about toolbox definitions and categories](https://developers.google.com/blockly/guides/configure/web/toolboxes/category).
66

77
## Installation
88

0 commit comments

Comments
 (0)