Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • B bootstrap
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 263
    • Issues 263
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 114
    • Merge requests 114
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Bootstrap
  • bootstrap
  • Issues
  • #15766
Closed
Open
Issue created Feb 08, 2015 by Administrator@rootContributor

Need Clearer Affix plugin documentation

Created by: impressivewebs

Two things to improve the documentation for Affix:

  1. What does this plugin do exactly? I understand there is a detailed description, and a live demo, but that doesn't really summarize it succinctly or clearly. Does the plugin just add classes? Does it track scrolling? I think it would be helpful to just add a brief sentence, explaining what it does, along with the statement about the live demo. The live demo is great, but it doesn't really help much because it's ScrollSpy that's doing a lot of that work, not just Affix. It might also help to state here exactly what ScrollSpy is doing and how Affix works with it.
  2. In the detailed description it says: "You must provide the styles for these classes yourself (independent of this plugin) to handle the actual positions." But then, a couple of lines later, it says "Scrolling past the element you want affixed should trigger the actual affixing. This is where .affix replaces .affix-top and sets position: fixed; (provided by Bootstrap's CSS)".

It took me a few minutes to understand those two statements, The first one seems to be saying that the developer has to add positioning, but then it says "position: fixed" is added by the class. Seemed contradictory at first. So as I understand it, Affix adds "position: fixed", but the developer needs to add the actual numeric offsets. Can you clarify this a little more, maybe specifying that the developer needs to supply the "top" values and whatnot?

Sorry if these are two different issues. I can open another one if necessary.

Assignee
Assign to
Time tracking