Selaa lähdekoodia

Docs: Updated module:utils/dom/position~Options#positions documentation.

Aleksander Nowodzinski 5 vuotta sitten
vanhempi
sitoutus
a4422470ce
1 muutettua tiedostoa jossa 3 lisäystä ja 1 poistoa
  1. 3 1
      packages/ckeditor5-utils/src/dom/position.js

+ 3 - 1
packages/ckeditor5-utils/src/dom/position.js

@@ -363,7 +363,7 @@ function getAbsoluteRectCoordinates( { left, top } ) {
 }
 
 /**
- * The `getOptimalPosition` helper options.
+ * The `getOptimalPosition()` helper options.
  *
  * @interface module:utils/dom/position~Options
  */
@@ -384,6 +384,8 @@ function getAbsoluteRectCoordinates( { left, top } ) {
  * An array of functions which return {@link module:utils/dom/position~Position} relative
  * to the `target`, in the order of preference.
  *
+ * **Note**: If a function returns `null`, it is ignored by the `getOptimalPosition()`.
+ *
  * @member {Array.<Function>} #positions
  */