Bladeren bron

Docs: Improved TableColorConfig documentation.

Aleksander Nowodzinski 5 jaren geleden
bovenliggende
commit
a1617cba90
1 gewijzigde bestanden met toevoegingen van 67 en 66 verwijderingen
  1. 67 66
      packages/ckeditor5-table/src/table.js

+ 67 - 66
packages/ckeditor5-table/src/table.js

@@ -65,75 +65,76 @@ export default class Table extends Plugin {
  */
 
 /**
- * Available font colors defined as an array of strings or objects.
+ * Available colors defined as an array of strings or objects.
+ *
+ * Used by {@link module:table/table~TableConfig#tableProperties} and {@link module:table/table~TableConfig#tableCellProperties}
+ * configurations.
  *
  * The default value registers the following colors:
  *
- *		const fontColorConfig = {
- *			colors: [
- *				{
- *					color: 'hsl(0, 0%, 0%)',
- *					label: 'Black'
- *				},
- *				{
- *					color: 'hsl(0, 0%, 30%)',
- *					label: 'Dim grey'
- *				},
- *				{
- *					color: 'hsl(0, 0%, 60%)',
- *					label: 'Grey'
- *				},
- *				{
- *					color: 'hsl(0, 0%, 90%)',
- *					label: 'Light grey'
- *				},
- *				{
- *					color: 'hsl(0, 0%, 100%)',
- *					label: 'White',
- *					hasBorder: true
- *				},
- *				{
- *					color: 'hsl(0, 75%, 60%)',
- *					label: 'Red'
- *				},
- *				{
- *					color: 'hsl(30, 75%, 60%)',
- *					label: 'Orange'
- *				},
- *				{
- *					color: 'hsl(60, 75%, 60%)',
- *					label: 'Yellow'
- *				},
- *				{
- *					color: 'hsl(90, 75%, 60%)',
- *					label: 'Light green'
- *				},
- *				{
- *					color: 'hsl(120, 75%, 60%)',
- *					label: 'Green'
- *				},
- *				{
- *					color: 'hsl(150, 75%, 60%)',
- *					label: 'Aquamarine'
- *				},
- *				{
- *					color: 'hsl(180, 75%, 60%)',
- *					label: 'Turquoise'
- *				},
- *				{
- *					color: 'hsl(210, 75%, 60%)',
- *					label: 'Light blue'
- *				},
- *				{
- *					color: 'hsl(240, 75%, 60%)',
- *					label: 'Blue'
- *				},
- *				{
- *					color: 'hsl(270, 75%, 60%)',
- *					label: 'Purple'
- *				}
- *			]
- *		};
+ *		const colorDefinitions = [
+ *			{
+ *				color: 'hsl(0, 0%, 0%)',
+ *				label: 'Black'
+ *			},
+ *			{
+ *				color: 'hsl(0, 0%, 30%)',
+ *				label: 'Dim grey'
+ *			},
+ *			{
+ *				color: 'hsl(0, 0%, 60%)',
+ *				label: 'Grey'
+ *			},
+ *			{
+ *				color: 'hsl(0, 0%, 90%)',
+ *				label: 'Light grey'
+ *			},
+ *			{
+ *				color: 'hsl(0, 0%, 100%)',
+ *				label: 'White',
+ *				hasBorder: true
+ *			},
+ *			{
+ *				color: 'hsl(0, 75%, 60%)',
+ *				label: 'Red'
+ *			},
+ *			{
+ *				color: 'hsl(30, 75%, 60%)',
+ *				label: 'Orange'
+ *			},
+ *			{
+ *				color: 'hsl(60, 75%, 60%)',
+ *				label: 'Yellow'
+ *			},
+ *			{
+ *				color: 'hsl(90, 75%, 60%)',
+ *				label: 'Light green'
+ *			},
+ *			{
+ *				color: 'hsl(120, 75%, 60%)',
+ *				label: 'Green'
+ *			},
+ *			{
+ *				color: 'hsl(150, 75%, 60%)',
+ *				label: 'Aquamarine'
+ *			},
+ *			{
+ *				color: 'hsl(180, 75%, 60%)',
+ *				label: 'Turquoise'
+ *			},
+ *			{
+ *				color: 'hsl(210, 75%, 60%)',
+ *				label: 'Light blue'
+ *			},
+ *			{
+ *				color: 'hsl(240, 75%, 60%)',
+ *				label: 'Blue'
+ *			},
+ *			{
+ *				color: 'hsl(270, 75%, 60%)',
+ *				label: 'Purple'
+ *			}
+ *		]
  *
  * @typedef {Array.<String|Object>} module:table/table~TableColorConfig
  */