1b5ff950cc
- primer-alerts@1.5.9 - primer-avatars@1.5.6 - primer-base@1.7.4 - primer-blankslate@1.4.9 - primer-box@2.5.9 - primer-branch-name@1.0.7 - primer-breadcrumb@1.5.5 - primer-buttons@2.6.0 - primer-core@6.10.3 - primer-forms@2.1.4 - primer-labels@1.5.9 - primer-layout@1.4.9 - primer-markdown@3.7.9 - primer-marketing-buttons@1.0.8 - primer-marketing-type@1.4.9 - primer-marketing-utilities@1.6.5 - primer-marketing@6.2.4 - primer-navigation@1.5.7 - primer-page-headers@1.4.9 - primer-page-sections@1.4.9 - primer-pagination@1.0.3 - primer-popover@0.1.3 - primer-product@5.6.6 - primer-subhead@1.0.7 - primer-support@4.6.0 - primer-table-object@1.4.9 - primer-tables@1.4.9 - primer-tooltips@1.5.7 - primer-truncate@1.4.9 - primer-utilities@4.12.0 - primer@10.8.0 - generator-primer-module@1.0.8 - primer-module-build@1.0.5 - stylelint-config-primer@2.2.10 - stylelint-selector-no-utility@1.8.10 |
||
|---|---|---|
| .. | ||
| lib | ||
| .npmignore | ||
| index.scss | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| stories.js | ||
Primer Truncate
.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>