Props incorrectly documented for FocalPointPicker

[dsifford]

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;

[UdokaVrede]

@nosolosw can I get further detail on this

[oandregal]

Sure! The issue here is that the docs of the component don't reflect what the code really does at the moment. Specifically, the dimensions property is no longer used. It'd be good to review whether the docs need other changes and prepare a Pull Request that updates them. Is this helpful?

[UdokaVrede]

If I am getting right, I'm to show what #dimensions does in the readme.md does in the code.

[seanvarnham]

Hi team, has there been any movement on this issue?

[skorasaurus]

Thanks for reporting; this was fixed in 4f21fdb and c5ae463