https://github.com/catamphetamine/web-browser-style
CSS utilities
https://github.com/catamphetamine/web-browser-style
Last synced: 3 months ago
JSON representation
CSS utilities
- Host: GitHub
- URL: https://github.com/catamphetamine/web-browser-style
- Owner: catamphetamine
- Created: 2023-01-24T13:51:17.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-11T12:06:13.000Z (about 2 years ago)
- Last Synced: 2025-01-11T01:48:47.459Z (5 months ago)
- Language: JavaScript
- Size: 23.4 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `web-browser-style`
Web browser CSS utilities.
## Install
```
npm install web-browser-style --save
```
## Use
* `px(value: number): string` — Rounds the amount of pixels with a sensible precision and appends `"px"` at the end. Example: `123.456789` → `"123.457px"`. Rounding could be used for less clutter in debugging and also for dealing with really big or really small numbers which could end up converted to a string using "exponential" format as `"1.2345e-50"`, and when a web browser receives such a weird value for a pixels amount, it considers it invalid. And if such an "invalid" pixels amount is used as part of a "complex" CSS property like `box-shadow` then the whole such property gets discarded. The rationale for rounding precision being `3` here is that no screen could currently resolve up to a `1,000`th fraction of a pixel.
* `scaleFactor(value: number): string` — Rounds a `tranform: scale()` value with a sensible precision and converts to a string. Example: `123.456456456456456456456...` → `"123.456456456"`. See the description of `px()` function for the rationale on rounding. The rationale for the rounding precision being about `10` here is that scaling a very high-resolution image to a single pixel should still be precise enough. So if an image has a width of `1,000,000,000px` then in order to scale it to `1px` the scale factor would be `1 / 1,000,000,000`.
* `percent(value: number): string` — Multplies the value by `100`, rounds it with a sensible precision and converts it to a string while appending `"%"` at the end. Example: `1.23456456456456456456456...` → `"123.456456456%"`. See the description of `px()` function for the rationale on rounding. The rationale for the rounding precision being about `10` here is that scaling a very high-resolution image to a single pixel should still be precise enough. So if an image has a width of `1,000,000,000px` then in order to scale it to `1px` the scale factor would be `1 / 1,000,000,000`.
* `ms(value: number): string` — Rounds the value with a sensible precision and converts it to a string while appending `"ms"` at the end. Example: `1.23456456456456456456456...` → `"123.456ms"`. See the description of `px()` function for the rationale on rounding. The rationale for the rounding precision being about `3` here is that a human eye can't resolve at `1,000,000` frames per second.
* `getCssVariable(variableName: string): string` — Returns the value for the specified CSS variable name.
* `getCssVariables(variableNames: string[]): string[]` — Returns the values for the specified CSS variable names.
* `getDimensionalCalculatedCssVariable(variableName: string): string` — Returns the value for the specified CSS variable name. This function could be used in cases when a CSS variable value is defined using a `calc()` function because in those cases the standard `getCssVariable()` function will return a value with a `calc()`. For example, `getCssVariable()` could return `"calc(14px*3)"` while `getDimensionalCalculatedCssVariable()` would return `"42px"`. This function works by creating a new DOM element, inserting it into the document, measuring it and then removing it from the document.
## Test
```
npm test
```
## GitHub Ban
On March 9th, 2020, GitHub, Inc. silently [banned](https://medium.com/@catamphetamine/how-github-blocked-me-and-all-my-libraries-c32c61f061d3) my account (erasing all my repos, issues and comments) without any notice or explanation. Because of that, all source codes had to be promptly moved to GitLab. The [GitHub repo](https://github.com/catamphetamine/web-browser-style) is now only used as a backup (you can star the repo there too), and the primary repo is now the [GitLab one](https://gitlab.com/catamphetamine/web-browser-style). Issues can be reported in any repo.
## License
[MIT](LICENSE)