Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Docs: fix specification for getInstance #41297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Apr 6, 2025
Merged

Docs: fix specification for getInstance #41297

merged 2 commits into from
Apr 6, 2025

Conversation

fulldecent
Copy link
Contributor

@fulldecent fulldecent commented Mar 14, 2025 •
edited
Loading

Description

Fixes documentation for Tooltip in docs.

getInstance had wrong documentation.

Motivation & Context

I confirmed the actual implementation matches my new documentation:

bootstrap/js/src/base-component.js

Lines 59 to 66 in 53171ad

// Static
static getInstance(element) {
return Data.get(getElement(element), this.DATA_KEY)
}
static getOrCreateInstance(element, config = {}) {
return this.getInstance(element) || new this(element, typeof config === 'object' ? config : null)
}

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

julien-deramond
julien-deramond approved these changes Apr 6, 2025
View reviewed changes
Copy link
Member

@julien-deramond julien-deramond left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Good catch @fulldecent, thanks for the patch!
I checked the documentation for getInstance and getOrCreateInstance for all other components. Everything's now OK.

@mdo mdo merged commit 9a01aa3 into twbs:main Apr 6, 2025
12 of 13 checks passed
madbob pushed a commit to madbob/bootstrap that referenced this pull request Apr 6, 2025
@fulldecent @julien-deramond @madbob
Docs: fix specification for getInstance (twbs#41297)
6e2985e 
Co-authored-by: Julien Déramond <[email protected]>
@github-project-automation github-project-automation bot moved this to To do in v5.3.6 Apr 9, 2025
@julien-deramond julien-deramond moved this from To do to Done in v5.3.6 Apr 9, 2025
This was referenced Aug 4, 2025
Open
Merged
This was referenced Aug 19, 2025
Closed
Closed
This was referenced Aug 26, 2025
Closed
Open
This was referenced Sep 2, 2025
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@julien-deramond julien-deramond julien-deramond approved these changes

Assignees
No one assigned
Labels
docs js v5
Projects
No open projects
v5.3.6
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@fulldecent @julien-deramond @mdo