primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-09-20 13:17:29 +03:00
Code Issues Projects Releases Wiki Activity
c1fc63d7d3
css/modules/primer-truncate
History
Jon Rohan 472e2307b3 Publish 
- primer-alerts@1.5.8
 - primer-avatars@1.5.5
 - primer-base@1.7.3
 - primer-blankslate@1.4.8
 - primer-box@2.5.8
 - primer-branch-name@1.0.6
 - primer-breadcrumb@1.5.4
 - primer-buttons@2.5.6
 - primer-core@6.10.2
 - primer-forms@2.1.3
 - primer-labels@1.5.8
 - primer-layout@1.4.8
 - primer-markdown@3.7.8
 - primer-marketing-buttons@1.0.7
 - primer-marketing-support@1.5.3
 - primer-marketing-type@1.4.8
 - primer-marketing-utilities@1.6.4
 - primer-marketing@6.2.3
 - primer-navigation@1.5.6
 - primer-page-headers@1.4.8
 - primer-page-sections@1.4.8
 - primer-pagination@1.0.2
 - primer-popover@0.1.2
 - primer-product@5.6.5
 - primer-subhead@1.0.6
 - primer-support@4.5.5
 - primer-table-object@1.4.8
 - primer-tables@1.4.8
 - primer-tooltips@1.5.6
 - primer-truncate@1.4.8
 - primer-utilities@4.11.2
 - primer@10.7.0
 - generator-primer-module@1.0.7
 - primer-module-build@1.0.4
 - stylelint-config-primer@2.2.9
 - stylelint-selector-no-utility@1.8.9
2018-06-29 13:49:27 -07:00
..
lib rename packages directory to modules 2017-06-29 12:49:16 -07:00
.npmignore rename packages directory to modules 2017-06-29 12:49:16 -07:00
index.scss rename packages directory to modules 2017-06-29 12:49:16 -07:00
LICENSE Happy new year 2018-01-03 15:05:16 -08:00
package-lock.json Adding package-lock.json back 2018-06-13 16:48:56 -07:00
package.json Publish 2018-06-29 13:49:27 -07:00
README.md Pulling in markdown components from all the rest of the modules 2018-01-09 15:27:14 -08:00
stories.js Pulling in markdown components from all the rest of the modules 2018-01-09 15:27:14 -08:00

README.md

Primer Truncate

npm version Build Status

.css-truncate will shorten text with an ellipsis. The maximum width of the truncated text can be changed by overriding the max-width of the .css-truncate-target.

This repository is a module of the full primer repository.

Install

This repository is distributed with npm. After installing npm, you can install primer-truncate with this command.

$ npm install --save primer-truncate

Usage

The source files included are written in Sass (scss) You can simply point your sass include-path at your node_modules directory and import it like this.

@import "primer-truncate/index.scss";

You can also import specific portions of the module by importing those partials from the /lib/ folder. Make sure you import any requirements along with the modules.

Build

For a compiled css version of this module, a npm script is included that will output a css version to build/build.css The built css file is also included in the npm package.

$ npm run build

Documentation

.css-truncate will shorten text with an ellipsis. The maximum width of the truncated text can be changed by overriding the max-width of .css-truncate-target. Unless the full text is so long that it affects performace, always add title to the truncated element so the full text can still be seen.

<span class="branch-ref css-truncate css-truncate-target" title="really-long-branch-name">
  really-long-branch-name
</span>

You can reveal the entire string on hover with the addition of .expandable.

<span class="css-truncate expandable">
  <span class="branch-ref css-truncate-target">this-is-a-really-long-branch-name</span>
</span>

License

MIT © GitHub