Documentation: Off-canvas events are improperly cased (Typo)

[ogzcoder]

Description

In the docs for Foundation 6 Off-canvas component it lists the event triggers to listen for as:

opened.zf.offCanvas | Fires when the off-canvas menu opens.
closed.zf.offCanvas | Fires when the off-canvas menu opens.

However neither of those events are ever triggered, however, when changed to a lowercase "c" everything works as it is supposed to:

opened.zf.offcanvas | Fires when the off-canvas menu opens.
closed.zf.offcanvas | Fires when the off-canvas menu opens.

Possible Solution

Change the docs to provide the correct casing for the events

Checklist

• I have read and follow the CONTRIBUTING.md document.
• here are no other issues similar to this one.
• The issue title and template are correctly filled.

[DanielRuf]

Please let us know which version of Foundation you use.

We changed the event names in the RC releases and the docs are for the latest release (see top left).

[ogzcoder]

I am using an rc release ... v6.5.0-rc.3, however it might be important to note that when installation is done through NPM - ´npm install foundation-sites´ this is the release that is installed

[DanielRuf]

Indeed.

cc @ncoden is the event name change not part of the current RC release?

[DanielRuf]

https://github.com/zurb/foundation-sites/blob/develop/js/foundation.offcanvas.js#L405

https://github.com/zurb/foundation-sites/blob/develop-v6.5/js/foundation.offcanvas.js#L354

[ncoden]

cc @ncoden is the event name change not part of the current RC release?

No it is not. It would be a breaking change.

This is a documentation issue, related to foundation/foundation-docs#24.
Duplicate of #11339

[ncoden]

I can't reproduce it locally. This has been fixed on foundation-docs in foundation/foundation-docs#24 and on foundation-sites in #11512. Closing.

[DanielRuf]

@ncoden see the docs.

There is currently opened.zf.offCanvas written.

6.5.0 RC3 uses opened.zf.offcanvas

[DanielRuf]

The docs do not reflect the current events in RC3. So the docs are not consistent atm.

[ncoden]

I seen the docs. But this is fixed in RC4 with #11512.
We can keep the issue open until it is released if you want. But so far, the policy was to close them as soon as the related PR is merged. This way, it is easier to be focused on "what should be done".

[ncoden]

My bad. I double checked everything and RC4 have the good event names but rely on the wrong version of foundation-docs: it uses a commit on develop to get the latest fixes but there is also new stuff on master.

I took a look at the history of this bug, and we are back at #10155. OffCanvas events are in CamelCase because we rely on memberof, which is the best information about the event namespace we can have (except for OffCanvas). There is too solutions now:

• Change the OffCanvas events documentation to make them part of the Offcanvas class (which is not true).
• Add support of event namespaces to Supercollider.

Edit: the JSdoc event namespaces don't work as I expected. So I guess we'll fake the className in the OffCanvas documentation for now.

[ncoden]

See #11526