Skip to content

Props incorrectly documented for FocalPointPicker #16056

Closed
Closed
Props incorrectly documented for FocalPointPicker#16056
Labels
Good First IssueAn issue that's suitable for someone looking to contribute for the first time[Package] Components/packages/components[Status] In ProgressTracking issues with work in progress[Type] Developer DocumentationDocumentation for developers
@dsifford

Description

@dsifford
dsifford
opened on Jun 9, 2019

Describe the bug
The docs for components/focal-point-picker state that dimensions is both a property, and required.

It appears that that prop was replaced with an internal function to get the dimensions from the DOM itself.

This should probably be removed to avoid confusion.

The relevant portion of the outdated docs:

gutenberg/packages/components/src/focal-point-picker/README.md

Lines 52 to 56 in a57202e

### `dimensions`
- Type: `Object`
- Required: Yes
- Description: An object describing the height and width of the image. Requires two paramaters: `height`, `width`.

The relevant portion of the code:

gutenberg/packages/components/src/focal-point-picker/index.js

Lines 57 to 63 in a57202e

const dimensions = {
width: this.imageRef.current.clientWidth,
height: this.imageRef.current.clientHeight,
};
const pickerDimensions = this.pickerDimensions();
const widthRatio = pickerDimensions.width / dimensions.width;
const heightRatio = pickerDimensions.height / dimensions.height;

Metadata

Metadata

Assignees

No one assigned

    Labels

    Good First IssueAn issue that's suitable for someone looking to contribute for the first time[Package] Components/packages/components[Status] In ProgressTracking issues with work in progress[Type] Developer DocumentationDocumentation for developers

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions