Skip to content
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.

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

Removed outdated note in oob swap documentation #2119

Merged
merged 1 commit into from
Dec 21, 2023

Conversation

Telroshan
Copy link
Collaborator

@Telroshan Telroshan commented Dec 21, 2023

Description

3 years ago, @1cg pushed this commit

allow hx-swap-oob to be at any level in returned content

Yet 3 years later, the hx-swap-oob documentation still states the following:

Out of band elements must be in the top level of the response, and not children of the top level elements.

which doesn't seem to be true anymore, given that the commit mentioned above introduced a test case for the nested elements scenario.

Btw, this also seems to make the multi-swap extension kinda obsolete now as its reason to exist as per its doc was:

Multi-swap can help in cases where OOB (Out of Band Swaps) is not enough for you. OOB requires HTML tags marked with hx-swap-oob attributes to be at the TOP level of HTML, which significantly limited its use. With OOB, it’s impossible to swap multiple elements arbitrarily placed and nested in the DOM tree.

Checklist

  • I have read the contribution guidelines
  • I have targeted this PR against the correct branch (master for website changes, dev for
    source changes)
  • This is either a bugfix, a documentation update, or a new feature that has been explicitly
    approved via an issue
  • I ran the test suite locally (npm run test) and verified that it succeeded

@Telroshan Telroshan added the documentation Improvements or additions to documentation label Dec 21, 2023
@alexpetros alexpetros merged commit 0b7a68e into bigskysoftware:master Dec 21, 2023
1 check passed
1cg pushed a commit that referenced this pull request Dec 21, 2023
devseppala added a commit to devseppala/htmxpath that referenced this pull request Dec 21, 2023
Removed outdated note in oob swap documentation (bigskysoftware#2119)
@Telroshan Telroshan deleted the fix-oob-swap-doc branch August 16, 2024 08:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants