Prevent Wrapping of <code> Tags in Text

By  on  

Writers of technical documentation (or lowly blog writers like myself) oftentimes put property names in <code> tags within blocks of text. Doing so makes reading the text easier and prevents users from misconstruing explanatory text with property names. CSS uses a dash within its property and value names and English uses dashes to signal a place where the line could break the text...see the problem here? The contents of your <code> tag could wrap and that can be unsightly. To prevent that smudge in your otherwise flawless writing, you can use white-space: nowrap:

code {
    white-space: nowrap;
}

The only downside of modifying white-space is that the code could flow well out of its container if the code text is lengthy. I would contend that length property names would be best placed on their own line (in their own block) but that issue is one to keep in mind. You could use text-overflow: ellipsis and a max-width to temper the element width, but the text could then lose its meaning.

It's up to you to decided if this could be safe for your own use. I just think it's a nice little addition to keep your content from breaking in ways you haven't thought of!

Recent Features

  • By
    Page Visibility API

    One event that's always been lacking within the document is a signal for when the user is looking at a given tab, or another tab. When does the user switch off our site to look at something else? When do they come back?

  • By
    How to Create a Twitter Card

    One of my favorite social APIs was the Open Graph API adopted by Facebook.  Adding just a few META tags to each page allowed links to my article to be styled and presented the way I wanted them to, giving me a bit of control...

Incredible Demos

  • By
    JavaScript Canvas Image Conversion

    At last week's Mozilla WebDev Offsite, we all spent half of the last day hacking on our future Mozilla Marketplace app. One mobile app that recently got a lot of attention was Instagram, which sold to Facebook for the bat shit crazy price of one...

  • By
    The Simple Intro to SVG Animation

    This article serves as a first step toward mastering SVG element animation. Included within are links to key resources for diving deeper, so bookmark this page and refer back to it throughout your journey toward SVG mastery. An SVG element is a special type of DOM element...

Discussion

  1. As an in between step or when modifying white-space is unwanted, you could use “‑” to show a dash but not break on it.

  2. Little late to the game here but…

    That’s an interesting problem you bring up at the end there. It is rare to have an inline code tag break out of its container, but there is a way around it. Here it is:

    http://jsbin.com/UQUfuXUX/1/edit

    Two things to note:

    – I’m using a non-breaking hyphen character, inserted with its decimal notation.
    – I’ve added word-wrap: break-word in the CSS to prevent long lines from breaking the container.

    Truthfully, it’s not an ideal solution to do this solely on the front-end. Preferrably you would have some sort of back-end function that automatically replaces hyphens inside of ‘code’ tags with the non-breaking hyphen character.

Wrap your code in <pre class="{language}"></pre> tags, link to a GitHub gist, JSFiddle fiddle, or CodePen pen to embed!