Skip to content

Documentation: fixedWidth deprecation notice is confusing for v6.7.0+ users #617

@bisonhubert

Description

@bisonhubert

Describe the bug
The fixedWidth prop deprecation notice in v6.7.2 type definitions states "@SInCE 7.0.0" but the prop doesn't work in v6.7.0+. Users are left unclear about what changed and when. Here is a link to the documentation:

/**
* @deprecated
* @since 7.0.0
*
* Starting in FontAwesome 7.0.0, all icons are fixed width by default.
* This property will be removed in a future version.
*
* If you want to remove the fixed width to replicate the behavior of
* previous versions, you can set the new {@link widthAuto} property to `true`.
*
* @see {@link FontAwesomeIconProps.widthAuto}
*/
fixedWidth?: boolean | undefined
/**

Reproducible test case
View the JSDoc comment in @fortawesome/react-fontawesome type definitions (index.d.ts) for the fixedWidth prop in v6.7.2+.

Expected behavior
The deprecation notice should clarify what actually changed in v6.7.0+ and why fixedWidth no longer works, rather than referencing @deprecated @since v7.0.0.

Desktop (please complete the following information):

  • Browser: Brave 1.85.118 (Official Build) (arm64), Firefox 146.0.1 (aarch64)
  • Version: react-fontawesome v3.0.2, @fortawesome/fontawesome-svg-core v6.7.2

Additional context
The current message creates confusion about whether the behavior changes in v6.7.0 or v7.0.0, and doesn't explain why fixedWidth is non-functional in v6.7.2.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions