Skip to content

[Breaking] Document and solidify the public API of FloatingUI#380

Merged
NullVoxPopuli merged 15 commits into
mainfrom
document-floating-ui
Oct 15, 2024
Merged

[Breaking] Document and solidify the public API of FloatingUI#380
NullVoxPopuli merged 15 commits into
mainfrom
document-floating-ui

Conversation

@NullVoxPopuli
Copy link
Copy Markdown
Contributor

@NullVoxPopuli NullVoxPopuli commented Oct 15, 2024

Resolves:

What:

  • Moves away from velcro terminology that folks might not be familiar with if they've never looked super close at how velcro works
  • Optimizes for the common case of only using a {{reference}} and {{floating}} modifier
  • The modifier-only usage has been renamed to {{anchorTo}}
    <button id="#reference"> ... </button>
    <menu {{anchorTo "#reference"}}> ... </menu>
  • Terms used for Popover have also changed to reflect the move away from "velcro"

Documentation:

  • New page for Floating UI
    • Component usage
    • modifier usage
      • passing Selector
      • passing element
  • Updates to the sidebar

@bolt-new-by-stackblitz
Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 15, 2024

Project Preview URL
Docs https://ed0054eb.ember-primitives.pages.dev

Logs

@NullVoxPopuli NullVoxPopuli changed the title Document and solidify the public API of FloatingUI [Breaking] Document and solidify the public API of FloatingUI Oct 15, 2024
@NullVoxPopuli NullVoxPopuli added the enhancement New feature or request label Oct 15, 2024
@NullVoxPopuli NullVoxPopuli merged commit 315d219 into main Oct 15, 2024
@NullVoxPopuli NullVoxPopuli deleted the document-floating-ui branch October 15, 2024 23:10
@github-actions github-actions Bot mentioned this pull request Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant