Skip to content

Commit 471a9ba

Browse files
TylorSTylorS
committed
Merge pull request #5 from TylorS/api-changes
API changes
2 parents 332912f + 3ea12b5 commit 471a9ba

29 files changed

+2733
-2394
lines changed

‎README.md

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,11 @@ The example found in the repo can be taken for a test-drive [here](http://tylors
3232
Here is a rundown of the `example` provided with this repo in the folder `/example`. This should allow a better understanding of how to use cyclic-router, for simplicity the styling has been removed here.
3333

3434
Starting in the file which has Cycle `run`, router driver needs to be created here along with the other drivers that you might be using.
35-
Looking at the imports below, [cyclic-history](https://github.com/tylors/cyclic-history) is being used instead of cycle-history.
3635

3736
```js
3837
// main.js
3938
import {run} from '@cycle/core'
4039
import {makeDOMDriver} from 'cycle-snabbdom'
41-
import {makeHistoryDriver} from 'cyclic-history'
4240
import {makeRouterDriver} from 'cyclic-router'
4341
import {createHashHistory} from 'history'
4442

@@ -47,12 +45,10 @@ import app from './app' // the function of your app
4745
run(app, {
4846
DOM: makeDOMDriver('#app'),
4947
// Notice how you need to feed in funcs from cyclic-history + history
50-
router: makeRouterDriver(makeHistoryDriver(createHashHistory())),
48+
router: makeRouterDriver(createHashHistory()),
5149
})
5250
```
5351

54-
In this instance we are using `cyclic-history` and `history` to deal with the history API, have a read of the history [docs](https://github.com/rackt/history/tree/master/docs#readme) to find out more information on how that all works.
55-
5652
###2.
5753

5854
App.js will be used as the place for showing the correct component in reference to current url (what you'd expect from a router!).
@@ -86,15 +82,15 @@ function view(sidebar, children) {
8682

8783
function App(sources) {
8884
const {router} = sources // get router out of sources
89-
const {path$, value$} = router.define(routes) // pass routes into the router
90-
const sidebar = Sidebar(sources, path$) // pass in sources and path$ into our sidebar
85+
const match$ = router.define(routes) // pass routes into the router
86+
const sidebar = Sidebar(sources, match$.pluck('path')) // pass in sources and path$ into our sidebar
9187

9288
// childrenDOM$ takes path$ from `router.define(routes)` above and zips it with values, here is where
9389
// the components swap in reference to the current url, notice router.path(path) is also passed in
9490
// for later use in nested routes.
9591
// This allows components to be nested without ever knowing they are actually nested.
96-
const childrenDOM$ = path$.zip(value$,
97-
(path, value) => value({...sources, router: router.path(path)}).DOM
92+
const childrenDOM$ = match$.map(
93+
({path, value}) => value({...sources, router: router.path(path)}).DOM
9894
)
9995

10096
return {
@@ -161,35 +157,31 @@ const routes = {
161157
'/compose': Compose,
162158
}
163159

164-
function view(createHref, path$, children) {
165-
return path$.map(() => {
166-
return div({},[
160+
function view(createHref) {
161+
return (children) =>
162+
div({}, [
167163
ul([
168164
li([
169-
a({props: {href: createHref('/why')},
170-
}, 'Why Cyclic Router?'),
165+
a({props: {href: createHref('/why')}}, 'Why Cyclic Router?'),
171166
]),
172167
li([
173-
a({props: {href: createHref('/built')},
174-
}, 'Built For Cycle.js'),
168+
a({props: {href: createHref('/built')}}, 'Built For Cycle.js'),
175169
]),
176170
li([
177-
a({props: {href: createHref('/compose')},
178-
}, 'Compose a Message'),
171+
a({props: {href: createHref('/compose')}}, 'Compose a Message'),
179172
]),
180173
]),
181174
children,
182175
])
183-
})
184176
}
185177

186178
function Inbox(sources) {
187179
const {router} = sources
188-
const {path$, value$} = router.define(routes)
180+
const match$ = router.define(routes)
189181

190-
const childrenDOM$ = value$.map(value => value(sources).DOM)
182+
const childrenDOM$ = match$.map(({value}) => value(sources).DOM)
191183

192-
return {DOM: view(router.createHref, path$, childrenDOM$)}
184+
return {DOM: childrenDOM$.map(view(router.createHref))}
193185
}
194186

195187
export default Inbox

‎docs/assets/fonts/source-code-pro/LICENSE.txt

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
2+
3+
This Font Software is licensed under the SIL Open Font License, Version 1.1.
4+
5+
This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL
6+
7+
8+
-----------------------------------------------------------
9+
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10+
-----------------------------------------------------------
11+
12+
PREAMBLE
13+
The goals of the Open Font License (OFL) are to stimulate worldwide
14+
development of collaborative font projects, to support the font creation
15+
efforts of academic and linguistic communities, and to provide a free and
16+
open framework in which fonts may be shared and improved in partnership
17+
with others.
18+
19+
The OFL allows the licensed fonts to be used, studied, modified and
20+
redistributed freely as long as they are not sold by themselves. The
21+
fonts, including any derivative works, can be bundled, embedded,
22+
redistributed and/or sold with any software provided that any reserved
23+
names are not used by derivative works. The fonts and derivatives,
24+
however, cannot be released under any other type of license. The
25+
requirement for fonts to remain under this license does not apply
26+
to any document created using the fonts or their derivatives.
27+
28+
DEFINITIONS
29+
"Font Software" refers to the set of files released by the Copyright
30+
Holder(s) under this license and clearly marked as such. This may
31+
include source files, build scripts and documentation.
32+
33+
"Reserved Font Name" refers to any names specified as such after the
34+
copyright statement(s).
35+
36+
"Original Version" refers to the collection of Font Software components as
37+
distributed by the Copyright Holder(s).
38+
39+
"Modified Version" refers to any derivative made by adding to, deleting,
40+
or substituting -- in part or in whole -- any of the components of the
41+
Original Version, by changing formats or by porting the Font Software to a
42+
new environment.
43+
44+
"Author" refers to any designer, engineer, programmer, technical
45+
writer or other person who contributed to the Font Software.
46+
47+
PERMISSION & CONDITIONS
48+
Permission is hereby granted, free of charge, to any person obtaining
49+
a copy of the Font Software, to use, study, copy, merge, embed, modify,
50+
redistribute, and sell modified and unmodified copies of the Font
51+
Software, subject to the following conditions:
52+
53+
1) Neither the Font Software nor any of its individual components,
54+
in Original or Modified Versions, may be sold by itself.
55+
56+
2) Original or Modified Versions of the Font Software may be bundled,
57+
redistributed and/or sold with any software, provided that each copy
58+
contains the above copyright notice and this license. These can be
59+
included either as stand-alone text files, human-readable headers or
60+
in the appropriate machine-readable metadata fields within text or
61+
binary files as long as those fields can be easily viewed by the user.
62+
63+
3) No Modified Version of the Font Software may use the Reserved Font
64+
Name(s) unless explicit written permission is granted by the corresponding
65+
Copyright Holder. This restriction only applies to the primary font name as
66+
presented to the users.
67+
68+
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69+
Software shall not be used to promote, endorse or advertise any
70+
Modified Version, except to acknowledge the contribution(s) of the
71+
Copyright Holder(s) and the Author(s) or with their explicit written
72+
permission.
73+
74+
5) The Font Software, modified or unmodified, in part or in whole,
75+
must be distributed entirely under this license, and must not be
76+
distributed under any other license. The requirement for fonts to
77+
remain under this license does not apply to any document created
78+
using the Font Software.
79+
80+
TERMINATION
81+
This license becomes null and void if any of the above conditions are
82+
not met.
83+
84+
DISCLAIMER
85+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88+
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90+
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91+
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92+
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93+
OTHER DEALINGS IN THE FONT SOFTWARE.

‎docs/assets/fonts/source-code-pro/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Source Code Pro
2+
3+
Source Code Pro is a set of OpenType fonts that have been designed to work well
4+
in user interface (UI) environments. In addition to a functional OpenType font, this open
5+
source project provides all of the source files that were used to build this OpenType font
6+
by using the AFDKO makeotf tool.
7+
8+
## Font installation instructions
9+
10+
* [Mac OS X](http://support.apple.com/kb/HT2509)
11+
* [Windows](http://windows.microsoft.com/en-us/windows-vista/install-or-uninstall-fonts)
12+
* [Linux/Unix-based systems](https://github.com/adobe-fonts/source-code-pro/issues/17#issuecomment-8967116)
13+
14+
## Getting Involved
15+
16+
Send suggestions for changes to the Source Code OpenType font project maintainer, [Paul D. Hunt](mailto:[email protected]?subject=[GitHub] Source Code Pro), for consideration.
17+
18+
## Further information
19+
20+
For information about the design and background of Source Code, please refer to the [official font readme file](http://www.adobe.com/products/type/font-information/source-code-pro-readme.html).

‎docs/assets/fonts/source-code-pro/WOFF/OTF/SourceCodePro-Regular.otf.woff

86.9 KB
Binary file not shown.

‎docs/assets/fonts/source-code-pro/source-code-pro.css

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
@font-face{
2+
font-family: 'Source Code Pro';
3+
font-weight: 400;
4+
font-style: normal;
5+
font-stretch: normal;
6+
src: url('WOFF/OTF/SourceCodePro-Regular.otf.woff') format('woff');
7+
}
8+
9+
@font-face{
10+
font-family: 'Source Code Pro';
11+
font-weight: 500;
12+
font-style: normal;
13+
font-stretch: normal;
14+
src: url('WOFF/OTF/SourceCodePro-Medium.otf.woff') format('woff');
15+
}

‎docs/assets/fonts/source-sans-pro/LICENSE.txt

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
Copyright 2010, 2012, 2014 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
2+
3+
This Font Software is licensed under the SIL Open Font License, Version 1.1.
4+
5+
This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL
6+
7+
8+
-----------------------------------------------------------
9+
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10+
-----------------------------------------------------------
11+
12+
PREAMBLE
13+
The goals of the Open Font License (OFL) are to stimulate worldwide
14+
development of collaborative font projects, to support the font creation
15+
efforts of academic and linguistic communities, and to provide a free and
16+
open framework in which fonts may be shared and improved in partnership
17+
with others.
18+
19+
The OFL allows the licensed fonts to be used, studied, modified and
20+
redistributed freely as long as they are not sold by themselves. The
21+
fonts, including any derivative works, can be bundled, embedded,
22+
redistributed and/or sold with any software provided that any reserved
23+
names are not used by derivative works. The fonts and derivatives,
24+
however, cannot be released under any other type of license. The
25+
requirement for fonts to remain under this license does not apply
26+
to any document created using the fonts or their derivatives.
27+
28+
DEFINITIONS
29+
"Font Software" refers to the set of files released by the Copyright
30+
Holder(s) under this license and clearly marked as such. This may
31+
include source files, build scripts and documentation.
32+
33+
"Reserved Font Name" refers to any names specified as such after the
34+
copyright statement(s).
35+
36+
"Original Version" refers to the collection of Font Software components as
37+
distributed by the Copyright Holder(s).
38+
39+
"Modified Version" refers to any derivative made by adding to, deleting,
40+
or substituting -- in part or in whole -- any of the components of the
41+
Original Version, by changing formats or by porting the Font Software to a
42+
new environment.
43+
44+
"Author" refers to any designer, engineer, programmer, technical
45+
writer or other person who contributed to the Font Software.
46+
47+
PERMISSION & CONDITIONS
48+
Permission is hereby granted, free of charge, to any person obtaining
49+
a copy of the Font Software, to use, study, copy, merge, embed, modify,
50+
redistribute, and sell modified and unmodified copies of the Font
51+
Software, subject to the following conditions:
52+
53+
1) Neither the Font Software nor any of its individual components,
54+
in Original or Modified Versions, may be sold by itself.
55+
56+
2) Original or Modified Versions of the Font Software may be bundled,
57+
redistributed and/or sold with any software, provided that each copy
58+
contains the above copyright notice and this license. These can be
59+
included either as stand-alone text files, human-readable headers or
60+
in the appropriate machine-readable metadata fields within text or
61+
binary files as long as those fields can be easily viewed by the user.
62+
63+
3) No Modified Version of the Font Software may use the Reserved Font
64+
Name(s) unless explicit written permission is granted by the corresponding
65+
Copyright Holder. This restriction only applies to the primary font name as
66+
presented to the users.
67+
68+
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69+
Software shall not be used to promote, endorse or advertise any
70+
Modified Version, except to acknowledge the contribution(s) of the
71+
Copyright Holder(s) and the Author(s) or with their explicit written
72+
permission.
73+
74+
5) The Font Software, modified or unmodified, in part or in whole,
75+
must be distributed entirely under this license, and must not be
76+
distributed under any other license. The requirement for fonts to
77+
remain under this license does not apply to any document created
78+
using the Font Software.
79+
80+
TERMINATION
81+
This license becomes null and void if any of the above conditions are
82+
not met.
83+
84+
DISCLAIMER
85+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88+
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90+
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91+
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92+
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93+
OTHER DEALINGS IN THE FONT SOFTWARE.

‎docs/assets/fonts/source-sans-pro/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Source Sans Pro
2+
3+
Source Sans Pro is a set of OpenType fonts that have been designed to work well
4+
in user interface (UI) environments. In addition to a functional OpenType font, this open
5+
source project provides all of the source files that were used to build this OpenType font
6+
by using the AFDKO makeotf tool.
7+
8+
## Font installation instructions
9+
10+
* [Mac OS X](http://support.apple.com/kb/HT2509)
11+
* [Windows](http://windows.microsoft.com/en-us/windows-vista/install-or-uninstall-fonts)
12+
* [Linux/Unix-based systems](https://github.com/adobe-fonts/source-code-pro/issues/17#issuecomment-8967116)
13+
14+
## Getting Involved
15+
16+
Send suggestions for changes to the Source Sans OpenType font project maintainer, [Paul D. Hunt](mailto:[email protected]?subject=[GitHub] Source Sans Pro), for consideration.
17+
18+
## Further information
19+
20+
For information about the design and background of Source Sans, please refer to the [official font readme file](http://www.adobe.com/products/type/font-information/source-sans-pro-readme.html).

‎docs/assets/fonts/source-sans-pro/WOFF/OTF/SourceSansPro-Bold.otf.woff

122 KB
Binary file not shown.

‎docs/assets/fonts/source-sans-pro/WOFF/OTF/SourceSansPro-Light.otf.woff

116 KB
Binary file not shown.

‎docs/assets/fonts/source-sans-pro/WOFF/OTF/SourceSansPro-Regular.otf.woff

119 KB
Binary file not shown.

0 commit comments

Comments
 (0)