Skip to content

Commit c2458a4

Browse files
committed
update links
1 parent 2af6ad5 commit c2458a4

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

api.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,13 @@ API
3333
### react-css-builder
3434
This is the object returned when calling ```require('react-css-builder')```
3535

36-
3736
#### register([namespace,] styleSet)
3837
* ***namespace***: (string) optional namespace used if any references will be made to another styleset from the styleset being registered
3938
* ***styleSet***: the object representing the set of styles (kind of like a stylesheet)
4039

4140
Register a set of styles which are associated with an alias which can be referenced like a css class.
4241

43-
Return the [CSSBuilder](#FIXME) object
42+
Return the [Stylesheet](#project/jhudson8/react-css-builder/package/Stylesheet) object
4443

4544
```
4645
module.exports = require('react-css-builder').register('some-namespace', {
@@ -53,7 +52,7 @@ module.exports = require('react-css-builder').register('some-namespace', {
5352
}
5453
});
5554
```
56-
see [Advanced Stylesets](#FIXME) to see all available options including, importing external stylesets, using mixins, variable references and nested styles.
55+
see [Examples](#project/jhudson8/react-css-builder/section/Examples) to see all available options including, importing external stylesets, using mixins, variable references and nested styles.
5756

5857
#### vars(varsObject)
5958
* ***varsObject***: a hash of variables to register which will be available to styleset rules (using this.get("varName")).
@@ -96,8 +95,9 @@ css.register('my-styleset', {
9695
});
9796
```
9897

99-
### StylesetBuilder
100-
This is the object returned when calling ```require('react-css-builder').register(...)```
98+
99+
### Stylesheet
100+
This is the object returned when calling ```require('react-css-builder').register(...)
101101

102102
#### css(className)
103103
* ***className***: return the styleset object matching the className key which can be used for associated with a React component ```style``` property.
@@ -125,7 +125,7 @@ stylesheet.css('panel.header'); // = {color: 'black'}
125125

126126
Very much like the previously described ```css``` method but allows for additional variables and style attributes to be provided. The ```css``` method is used to return the style response.
127127

128-
Returns a [StyleSelector](#FIXME)
128+
Returns a [StylesetBuilder](#project/jhudson8/react-css-builder/package/StylesetBuilder)
129129

130130
```
131131
var stylesheet = require('...').register(...)
@@ -144,16 +144,16 @@ stylesheet.get('myStyle')
144144
* ***mixinName***: the name of the mixin
145145
* ***mixinFunction***: the mixin function which can take any number of arguments
146146

147-
Exactly the same as [mixin](#FIXME) except that the mixin registered will *only* be accessable to this particular stylesheet.
147+
Exactly the same as [react-css-builder mixin](#project/jhudson8/react-css-builder/method/react-css-builder/mixin) except that the mixin registered will *only* be accessable to this particular stylesheet.
148148

149149
#### vars(varsObject)
150150
* ***varsObject***: a hash of variables to register which will be available to styleset rules (using this.get("varName")).
151151

152-
Exactly the same as [vars](#FIXME) except that the provided variables will *only* be accessable to this particular stylesheet.
152+
Exactly the same as [react-css-builder vars](l#project/jhudson8/react-css-builder/method/react-css-builder/vars) except that the provided variables will *only* be accessable to this particular stylesheet.
153153

154154

155155
### StylesetBuilder
156-
This is the object returned when calling ```get``` from a [StylesetBuilder](#FIXME). It is used to apply variables and attributes to a styleset request.
156+
This is the object returned when calling ```get``` from a [StylesetBuilder](#project/jhudson8/react-css-builder/package/StylesetBuilder). It is used to apply variables and attributes to a styleset request.
157157

158158
#### attr(styleAttributes)
159159
* ***styleAttributes***: Additional attributes that should be included with the attributes defined with the styleset defined by the class name.

0 commit comments

Comments
 (0)