Skip to content
This repository was archived by the owner on Mar 13, 2025. It is now read-only.

Commit d185e09

Browse files
committed
Adds documentation on fonts and style variables (mixins)
1 parent 7c50ce4 commit d185e09

File tree

8 files changed

+150
-921
lines changed

8 files changed

+150
-921
lines changed

Diff for: README.md

+31
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
11
# Topcoder React UI Kit
22

33
The [Topcoder](https://www.topcoder.com) UI Kit for internal ReactJS projects.
4+
5+
### Installation
6+
Install the package via NPM:
7+
```
8+
$ npm install --save topcoder-react-ui-kit
9+
```
10+
11+
Import its global stylesheet into the root ReactJS component of your app:
12+
```jsx
13+
import 'topcoder-react-ui-kit/dist/style.css';
14+
```
15+
16+
### Global Styles
17+
The import of `topcoder-react-ui-kit/dist/style.css` stylesheet provides you with
18+
(assuming that your Webpack config properly parses that stylesheet, and bundles
19+
all assets referenced from there into your bundle):
20+
- [**`Fonts`**](docs/fonts.md) — Declaration of standard Topcoder fonts;
21+
22+
### Style Mixins
23+
To use any of the style mixins in your SCSS code you should import them as
24+
```scss
25+
@import "~topcoder-react-ui-kit/src/styles/mixins";
26+
```
27+
- [**`Variables`**](docs/variables.md) — Standard colors, design break
28+
points and other global style constants;
29+
30+
### Development
31+
*To be written*
32+
33+
### License
34+
UNLICENSED — for internal Topcoder projects only.

Diff for: docs/fonts.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Fonts
2+
Declarations of standard Topcoder fonts:
3+
- [**`Roboto`**](https://fonts.google.com/specimen/Roboto)
4+

Diff for: docs/images/variables-colors.png

222 KB
Loading

Diff for: docs/variables.md

+109
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# Variables
2+
SCSS mixins for standard colors, design breaking points and other global style
3+
constants.
4+
5+
### Base Spacings
6+
*Note:* The constants from this section are defined mostly for documentation
7+
purposes. Although SCSS allows to really encode layout spacings as mathematical
8+
expressions using these constants; it is not practical, as results in less
9+
readable SCSS code and demands one to calculate the resulting values in head to
10+
check whether the numbers match the design specifications (which usually give
11+
the final numbers). Thus, for border radii and spacings prefer to put the final
12+
numbers directly into your SCSS code.
13+
- **`$base-unit`** — *5px* — All layout spacings in Topcoder designs
14+
are multiples of this value.
15+
- **`$corner-radius`** — *2px* — All corner radii (`border-radius`
16+
CSS prop) in Topcoder designs are multiples of this value.
17+
18+
### Design Break Points
19+
Each of the following constants specifies the maximal size of the corresponding
20+
screen size; i.e. XS-screen (extra-small) is any screen with the width smaller
21+
or equal to `$tc-screen-xs`, SM-screen (small) is any screen with the width
22+
larger than `$tc-screen-xs` and smaller or equal to `$tc-screen-sm`, and so on.
23+
The screen size wider than `$tc-screen-lg` we call XL for extra-large.
24+
25+
We assume that mobile devices have SM screen size, tablets have MD screen size,
26+
and desktops have LG or XL screen size. Whenever you need to restric the maximal
27+
width of the main page part, rely on `$tc-screen-lg` as the maximal width.
28+
29+
- **`$tc-screen-xs`** — *320px*;
30+
- **`$tc-screen-sm`** — *768px*;
31+
- **`$tc-screen-md`** — *1024px*;
32+
- **`$tc-screen-lg`** — *1280px*.
33+
34+
### Colors
35+
Here are the standard colors to be used in Topcoder designs. They match the
36+
design specs image below, but some of them have different names due to historic
37+
reasons:
38+
39+
##### Primary Colors
40+
- **`$tc-light-blue`** — `#26ade9`;
41+
- **`$tc-green`** — `#60c700`;
42+
- **`$tc-orange`** — `#fb7d22`;
43+
- **`$tc-yellow`** — `#fff100`;
44+
45+
- **`$tc-black`** — `#262628`;
46+
- **`$tc-gray-90`** — `#37373c`;
47+
- **`$tc-gray-80`** — `#47474f`;
48+
- **`$tc-gray-70`** — `#5d5d66`;
49+
- **`$tc-gray-60`** — `#747480`;
50+
- **`$tc-gray-50`** — `#888894`;
51+
- **`$tc-gray-40`** — `#a3a3ad`;
52+
- **`$tc-gray-30`** — `#c3c3c8`;
53+
- **`$tc-gray-20`** — `#dcdce0`;
54+
- **`$tc-gray-10`** — `#ededf2`;
55+
56+
- **`$tc-gray-neutral-dark`** — `#ebebeb`;
57+
- **`$tc-gray-neutral-light`** — `#fafafb`;
58+
- **`$tc-white`** — `#fff`;
59+
60+
##### Accents & Shades
61+
- **`$tc-dark-blue`** — `#0a71e6`;
62+
- **`$tc-dark-blue-90`** — `#1a85ff`;
63+
- **`$tc-dark-blue-70`** — `#59a7ff`;
64+
- **`$tc-dark-blue-30`** — `#cfe6ff`;
65+
- **`$tc-dark-blue-10`** — `#f4f9ff`;
66+
67+
- **`$tc-red`** — `#f22f24`;
68+
- **`$tc-red-70`** — `#ff5b52`;
69+
- **`$tc-red-30`** — `#ffd4d1`;
70+
- **`$tc-red-10`** — `#fff4f4`;
71+
72+
- **`$tc-gold`** — `#fce217`;
73+
- **`$tc-gold-70`** — `#faed8e`;
74+
- **`$tc-gold-30`** — `#fff7cc`;
75+
- **`$tc-gold-10`** — `#fffde6`;
76+
77+
- **`$tc-green`** — `#60c700`;
78+
- **`$tc-green-70`** — `#96d957`;
79+
- **`$tc-green-30`** — `#cfefb2`;
80+
- **`$tc-green-10`** — `#effae5`;
81+
82+
- **`$tc-light-blue`** — `#26ade9`;
83+
- **`$tc-light-blue-70`** — `#67c5ef`;
84+
- **`$tc-light-blue-30`** — `#bde6f8`;
85+
- **`$tc-light-blue-10`** — `#e9f6fc`;
86+
87+
- **`$tc-orange`** — `#fb7d22`;
88+
- **`$tc-orange-70`** — `#fda464`;
89+
- **`$tc-orange-30`** — `#fee3d0`;
90+
- **`$tc-orange-10`** — `#fff0eb`;
91+
92+
- **`$tc-purple`** — `#9050a3`;
93+
- **`$tc-purple-70`** — `#b47dd6`;
94+
- **`$tc-purple-30`** — `#e2c7f2`;
95+
- **`$tc-purple-10`** — `#f8f2fb`;
96+
97+
##### Badges
98+
- **`$tc-gold`** — `#fce217`;
99+
- **`$tc-silver`** — `#a9bcd4`;
100+
- **`$tc-bronze`** — `#bd731e`;
101+
102+
##### Levels
103+
- **`$tc-level-1`** — `$a3a3ad`;
104+
- **`$tc-level-2`** — `#25c089`;
105+
- **`$tc-level-3`** — `#666eff`;
106+
- **`$tc-level-4`** — `#fcb816`;
107+
- **`$tc-level-5`** — `#e6175c`;
108+
109+
![Standard TC Colors](images/variables-colors.png)

0 commit comments

Comments
 (0)