Skip to content

Docs: fix popover option types - #42707

Merged
julien-deramond merged 1 commit into
twbs:v5-devfrom
Kevinjohn:fix-popover-option-types
Oct 27, 2026
Merged

julien-deramond merged 1 commit into
twbs:v5-devfrom
Kevinjohn:fix-popover-option-types

Conversation

@Kevinjohn

@Kevinjohn Kevinjohn commented Jul 19, 2026 •

Copy link
Copy Markdown
Contributor

Description

Fixes the documented types for three popover options.

Motivation & Context

The popover options table had drifted from the JavaScript DefaultType definitions shared with Tooltip and extended by Popover:

Expected: documented option types match the accepted runtime config types.
Actual: fallbackPlacements included string, offset included number and omitted array, and content omitted null.

This updates the Popover docs table so those rows match the source types.

Type of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (non-breaking change)
  • Breaking change (fix or feature that would change existing functionality)

Checklist

  • I have read the contributing guidelines
  • My code follows the code style of the project (using npm run lint)
  • My change introduces changes to the documentation
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed

Live previews

Related issues

None.

Checks

  • git diff --check
  • npm exec -- prettier --config site/.prettierrc.json -c site/src/content/docs/components/popovers.mdx
  • npm run docs-build

@julien-deramond julien-deramond added docs Documentation site and its content v5 v5, the v5-dev branch labels Jul 20, 2026
@julien-deramond julien-deramond added the has-conflicts Conflicts with its base branch: needs a rebase label Oct 10, 2026
@julien-deramond
julien-deramond force-pushed the fix-popover-option-types branch from c6b4fba to 3f31f16 Compare October 27, 2026 05:47
@julien-deramond
julien-deramond marked this pull request as ready for review October 27, 2026 05:47
@github-project-automation github-project-automation Bot moved this to Needs review in v5.4.0 Oct 27, 2026
@julien-deramond julien-deramond removed the has-conflicts Conflicts with its base branch: needs a rebase label Oct 27, 2026

@julien-deramond julien-deramond left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I checked the three rows against js/src/tooltip.js and js/src/popover.js on v5-dev: fallbackPlacements is 'array', offset is '(array|string|function)' and Popover's content is '(null|string|element|function)', so the table now matches the runtime types (and the Tooltip docs, which already list array for both).

@github-project-automation github-project-automation Bot moved this from Needs review to Ready to merge in v5.4.0 Oct 27, 2026
@julien-deramond
julien-deramond merged commit d7e1897 into twbs:v5-dev Oct 27, 2026
9 checks passed
@github-project-automation github-project-automation Bot moved this from Ready to merge to Done in v5.4.0 Oct 27, 2026
@julien-deramond julien-deramond added backport-done The backport is merged backport-to-v6 Merged on v5, to backport to v6 labels Oct 27, 2026
@mdo mdo removed this from v5.4.0 Nov 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-done The backport is merged backport-to-v6 Merged on v5, to backport to v6 docs Documentation site and its content v5 v5, the v5-dev branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants