htmx icon indicating copy to clipboard operation
htmx copied to clipboard

Should "included extensions" be renamed to "official extensions"? Extensions docs say that they are included with htmx "out of the box" but also suggest that the extensions need to be downloaded separately?

Open alecgargett opened this issue 1 year ago • 4 comments

Hi Big Sky,

Love your work!

The extension docs say

"htmx includes a set of extensions out of the box that address common developer needs. ... You can find the source for the bundled extensions at https://unpkg.com/browse/htmx.org/dist/ext/. You will need to include the javascript file for the extension and then install it using the hx-ext attributes."

To me this is a little confusing because "out of the box" sounds to me like they are part of the htmx.js file & don't need a separate download but the next paragraph suggests the opposite?

I just thought I'd let you know in case you agree it's confusing or in case I'm missing something.

Cheers, Alec

alecgargett avatar Feb 04 '24 06:02 alecgargett

You could call them official extensions or "extensions that are supported out of the box" or similar if the goal is to emphasise that they're not third-party.

alecgargett avatar Feb 04 '24 08:02 alecgargett

I'm thinking of doing a PR to do some minor changes to the extensions documentation at both

https://htmx.org/docs/#extensions

and

https://htmx.org/extensions

The changes would be things like:

  1. "Included extensions" --> "Official extensions"
  2. Contents list at the top of the extensions page.
  3. "htmx includes a set of extensions out of the box that address common developer needs." --> "htmx includes out-of-the-box support for a set of extensions that address common developer needs"
  4. One minor change to formatting

Does anyone want to voice objections before I go ahead and do that?

alecgargett avatar Feb 23 '24 10:02 alecgargett

Hey, we are moving extensions to a separate repo and website (on a subdomain) for htmx 2, so this whole section will be reworked! I would suggest holding off such a PR for now

Telroshan avatar Feb 25 '24 21:02 Telroshan

Hey, we are moving extensions to a separate repo and website (on a subdomain) for htmx 2, so this whole section will be reworked! I would suggest holding off such a PR for now

Thanks for letting me know.

alecgargett avatar Feb 26 '24 01:02 alecgargett