summaryrefslogtreecommitdiff
path: root/live/static/fork-awesome/src/doc/_includes/new-naming.html
blob: 0a0a4811402c817005b5569538e32f16d5b29de2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<section id="new-naming">
  <h2 class="page-header">New Naming Conventions in {{ site.forkawesome.minor_version }}</h2>
  <p class="lead text-center alert alert-success">fa-[name]-[shape]-[o]-[direction]</p>
  <p>
    A desire for better icon naming <strong>consistency</strong> and <strong>predictability</strong> are at the heart
    of the changes in naming conventions. Once you know the name of the base icon shape, you should be able to predict
    the names of variants.
  </p>
  <div class="row">
    <div class="col-lg-3 col-md-4 col-sm-6">
      <h4 class="margin-bottom-sm">fa-*</h4>
      <p class="margin-bottom-sm">Solid icons as the base variant</p>
      <ul class="fa-ul padding-left-sm">
        <li>
          <i class="fa fa-bookmark fa-li" aria-hidden="true"></i>
          fa-bookmark
        </li>
        <li>
          <i class="fa fa-comment fa-li" aria-hidden="true"></i>
          fa-comment
        </li>
        <li>
          <i class="fa fa-folder fa-li" aria-hidden="true"></i>
          fa-folder
        </li>
      </ul>
    </div>
    <div class="col-lg-3 col-md-4 col-sm-6">
      <h4 class="margin-bottom-sm">*-o</h4>
      <p class="margin-bottom-sm">Outlined version of previous modifier</p>
      <ul class="fa-ul padding-left-sm">
        <li>
          <i class="fa fa-bookmark-o fa-li" aria-hidden="true"></i>
          fa-bookmark-o
        </li>
        <li>
          <i class="fa fa-comment-o fa-li" aria-hidden="true"></i>
          fa-comment-o
        </li>
        <li>
          <i class="fa fa-folder-o fa-li" aria-hidden="true"></i>
          fa-folder-o
        </li>
      </ul>
    </div>
    <div class="col-lg-3 col-md-4 col-sm-6">
      <h4 class="margin-bottom-sm">*-circle</h4>
      <p class="margin-bottom-sm">Circle under previous modifier</p>
      <ul class="fa-ul padding-left-sm">
        <li>
          <i class="fa fa-check-circle fa-li" aria-hidden="true"></i>
          fa-check-circle
        </li>
        <li>
          <i class="fa fa-exclamation-circle fa-li" aria-hidden="true"></i>
          fa-exclamation-circle
        </li>
        <li>
          <i class="fa fa-plus-circle fa-li" aria-hidden="true"></i>
          fa-plus-circle
        </li>
      </ul>
    </div>
    <div class="col-lg-3 col-md-4 col-sm-6">
      <h4 class="margin-bottom-sm">*-square</h4>
      <p class="margin-bottom-sm">Square under previous modifier</p>
      <ul class="fa-ul padding-left-sm">
        <li>
          <i class="fa fa-check-square fa-li" aria-hidden="true"></i>
          fa-check-square
        </li>
        <li>
          <i class="fa fa-twitter-square fa-li" aria-hidden="true"></i>
          fa-twitter-square
        </li>
        <li>
          <i class="fa fa-plus-square fa-li" aria-hidden="true"></i>
          fa-plus-square
        </li>
      </ul>
    </div>
    <div class="col-lg-3 col-md-4 col-sm-6">
      <h4 class="margin-bottom-sm">*-right, *-up, etc.</h4>
      <p class="margin-bottom-sm">Directional modifier always at the end</p>
      <ul class="fa-ul padding-left-sm">
        <li>
          <i class="fa fa-arrow-right fa-li" aria-hidden="true"></i>
          fa-arrow-right
        </li>
        <li>
          <i class="fa fa-arrow-circle-right fa-li" aria-hidden="true"></i>
          fa-arrow-circle-right
        </li>
        <li>
          <i class="fa fa-angle-double-right fa-li" aria-hidden="true"></i>
          fa-angle-double-right
        </li>
      </ul>
    </div>
    <div class="col-lg-3 col-md-4 col-sm-6">
      <h4 class="margin-bottom-sm">*-alt</h4>
      <p class="margin-bottom-sm">Alternative to the original</p>
      <ul class="fa-ul padding-left-sm">
        <li>
          <i class="fa fa-unlock-alt fa-li" aria-hidden="true"></i>
          fa-unlock-alt
        </li>
        <li>
          <i class="fa fa-list-alt fa-li" aria-hidden="true"></i>
          fa-list-alt
        </li>
        <li>
          <i class="fa fa-github-alt fa-li" aria-hidden="true"></i>
          fa-github-alt
        </li>
      </ul>
    </div>
    <div class="col-lg-3 col-md-4 col-sm-6">
      <h4 class="margin-bottom-sm">*-h, *-v</h4>
      <p class="margin-bottom-sm">Horizontal &amp; vertical modifiers</p>
      <ul class="fa-ul padding-left-sm">
        <li>
          <i class="fa fa-arrows-v fa-li" aria-hidden="true"></i>
          fa-arrows-v
        </li>
        <li>
          <i class="fa fa-arrows-h fa-li" aria-hidden="true"></i>
          fa-arrows-h
        </li>
        <li>
          <i class="fa fa-ellipsis-v fa-li" aria-hidden="true"></i>
          fa-ellipsis-v
        </li>
      </ul>
    </div>
    <div class="col-lg-3 col-md-4 col-sm-6">
      <h4 class="margin-bottom-sm">Combine 'em up&helip;</h4>
      <p class="margin-bottom-sm">Consistent when strung together</p>
      <ul class="fa-ul padding-left-sm">
        <li>
          <i class="fa fa-arrow-circle-o-right fa-li" aria-hidden="true"></i>
          fa-arrow-circle-o-right
        </li>
        <li>
          <i class="fa fa-caret-square-o-right fa-li" aria-hidden="true"></i>
          fa-caret-square-o-right
        </li>
        <li>
          <i class="fa fa-hand-o-right fa-li" aria-hidden="true"></i>
          fa-hand-o-right
        </li>
      </ul>
    </div>

  </div>

</section>