├── .vscode └── settings.json ├── doc.go ├── init.go ├── go.mod ├── redirect.go ├── notfound.go ├── link.go ├── router_test.go ├── go.sum ├── README.md ├── router.go └── LICENSE /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "go.toolsEnvVars": { 3 | "GOOS": "js", 4 | "GOARCH": "wasm" 5 | }, 6 | } -------------------------------------------------------------------------------- /doc.go: -------------------------------------------------------------------------------- 1 | // Package router implements a simple history API router for 2 | // Vecty (github.com/hexops/vecty). It can match exact patterns 3 | // as well as named variables such as /users/{id} 4 | package router // import "marwan.io/vecty-router" 5 | -------------------------------------------------------------------------------- /init.go: -------------------------------------------------------------------------------- 1 | package router 2 | 3 | import ( 4 | "syscall/js" 5 | ) 6 | 7 | func init() { 8 | js.Global().Set("onpopstate", js.FuncOf(func(this js.Value, args []js.Value) interface{} { 9 | refreshRoutes() 10 | return nil 11 | })) 12 | } 13 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module marwan.io/vecty-router 2 | 3 | go 1.12 4 | 5 | require ( 6 | github.com/cathalgarvey/fmtless v0.0.0-20160509115409-5077ea938891 7 | github.com/hexops/vecty v0.5.1-0.20200816075853-64e387e2b2b3 8 | github.com/stretchr/testify v1.3.0 // indirect 9 | ) 10 | -------------------------------------------------------------------------------- /redirect.go: -------------------------------------------------------------------------------- 1 | package router 2 | 3 | import ( 4 | "syscall/js" 5 | ) 6 | 7 | // Redirect ... 8 | func Redirect(route string) { 9 | js.Global().Get("history").Call( 10 | "pushState", 11 | map[string]interface{}{"redirectRoute": route}, 12 | route, 13 | route, 14 | ) 15 | refreshRoutes() 16 | } 17 | -------------------------------------------------------------------------------- /notfound.go: -------------------------------------------------------------------------------- 1 | package router 2 | 3 | import ( 4 | "github.com/hexops/vecty" 5 | ) 6 | 7 | var nf *notFound 8 | 9 | // NotFoundHandler renders if no routes are matched at all. 10 | func NotFoundHandler(c vecty.Component) vecty.Component { 11 | r := ¬Found{c: c} 12 | nf = r 13 | return r 14 | } 15 | 16 | type notFound struct { 17 | vecty.Core 18 | c vecty.Component 19 | } 20 | 21 | func (r *notFound) Render() vecty.ComponentOrHTML { 22 | path := pathname() 23 | 24 | for _, r := range routes { 25 | if r.p.MatchString(path) { 26 | return nil 27 | } 28 | } 29 | 30 | return r.c 31 | } 32 | -------------------------------------------------------------------------------- /link.go: -------------------------------------------------------------------------------- 1 | package router 2 | 3 | import ( 4 | "github.com/hexops/vecty" 5 | "github.com/hexops/vecty/elem" 6 | "github.com/hexops/vecty/event" 7 | "github.com/hexops/vecty/prop" 8 | ) 9 | 10 | // EventCallback defines a vecty onClick handler 11 | type EventCallback func(e *vecty.Event) 12 | 13 | // LinkOptions - use to pass extra options to the link element 14 | // like an ID, or class attribute. 15 | type LinkOptions struct { 16 | ID string 17 | Class string 18 | } 19 | 20 | // Link implements a frontend history Anchor tag. 21 | func Link(route, text string, opts LinkOptions) *vecty.HTML { 22 | return elem.Anchor( 23 | vecty.Markup( 24 | prop.Href(route), 25 | vecty.MarkupIf(opts.ID != "", prop.ID(opts.ID)), 26 | vecty.MarkupIf(opts.Class != "", vecty.Class(opts.Class)), 27 | event.Click(onClick(route)).PreventDefault(), 28 | ), 29 | vecty.Text(text), 30 | ) 31 | } 32 | 33 | func onClick(route string) EventCallback { 34 | return func(e *vecty.Event) { 35 | Redirect(route) 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /router_test.go: -------------------------------------------------------------------------------- 1 | package router 2 | 3 | import "testing" 4 | 5 | func TestRouter(t *testing.T) { 6 | usersPath := "/users" 7 | 8 | tt := []struct { 9 | name string 10 | route *Route 11 | match string 12 | expected bool 13 | }{ 14 | { 15 | "exact match positiive", 16 | NewRoute(usersPath, nil, NewRouteOpts{ExactMatch: true}), 17 | "/users", 18 | true, 19 | }, 20 | { 21 | "exact match negative", 22 | NewRoute(usersPath, nil, NewRouteOpts{ExactMatch: true}), 23 | "/users/1", 24 | false, 25 | }, 26 | { 27 | "loose match exact", 28 | NewRoute(usersPath, nil, NewRouteOpts{ExactMatch: false}), 29 | "/users", 30 | true, 31 | }, 32 | { 33 | "loose match loose", 34 | NewRoute(usersPath, nil, NewRouteOpts{ExactMatch: false}), 35 | "/users/1", 36 | true, 37 | }, 38 | } 39 | 40 | for _, tc := range tt { 41 | t.Run(tc.name, func(t *testing.T) { 42 | if tc.route.p.MatchString(tc.match) != tc.expected { 43 | t.Errorf("expected %v to have a %v match for %v", usersPath, tc.expected, tc.match) 44 | } 45 | }) 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/cathalgarvey/fmtless v0.0.0-20160509115409-5077ea938891 h1:xI+8e6zab6gwsycpo0sENGYF8DmagNYnyOxpRhnA1eE= 2 | github.com/cathalgarvey/fmtless v0.0.0-20160509115409-5077ea938891/go.mod h1:47i2Tts0Ndudv8RXhALRmYzK4gB8Qh39wOGy5H9FIOU= 3 | github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= 4 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 5 | github.com/hexops/vecty v0.5.0 h1:pnaU0yIo0sT3WlDXi22WA9FNhwiswnHb+1mbS8wISW4= 6 | github.com/hexops/vecty v0.5.0/go.mod h1:Yd9AOfl6lN1BWnVnvaSBwKiTCAcnlIGGvdsODOOZ9RY= 7 | github.com/hexops/vecty v0.5.1-0.20200816075853-64e387e2b2b3 h1:PucoKHrGpdxIS6sbp56HpxyUumnL0A0AtcU0xsFRDOk= 8 | github.com/hexops/vecty v0.5.1-0.20200816075853-64e387e2b2b3/go.mod h1:hVOPHAhrkXTf/9fl31Bpn2QvkW2ZOUZ0I3b3cohwCpI= 9 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 10 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 11 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 12 | github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q= 13 | github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= 14 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Vecty Router 2 | 3 | A declarative client-side router for [Vecty](https://www.github.com/hexops/vecty) applications. 4 | Similar to [react-router v4](https://github.com/ReactTraining/react-router) 5 | 6 | ### Installation 7 | 8 | `go get marwan.io/vecty-router` 9 | 10 | ### Usage 11 | 12 | You don't need to declare your routes at the top level. You can declare them inside any component 13 | and if they match they will render, otherwise, router will render an empty div instead. 14 | 15 | ```go 16 | package components 17 | 18 | import ( 19 | "github.com/hexops/vecty" 20 | "github.com/hexops/vecty/elem" 21 | "marwan.io/vecty-router" 22 | ) 23 | 24 | // Body renders the tag 25 | type Body struct { 26 | vecty.Core 27 | } 28 | 29 | // Render renders the tag with the App as its children 30 | func (b *Body) Render() vecty.ComponentOrHTML { 31 | return elem.Body( 32 | router.NewRoute("/", &MainView{}, router.NewRouteOpts{ExactMatch: true}), 33 | router.NewRoute("/blog", &Blog{}, router.NewRouteOpts{}), 34 | router.NewRoute("/blog/{id}", &PostView{}, router.NewRouteOpts{ExactMatch: true}), 35 | ) 36 | } 37 | ``` 38 | 39 | To retrieve a named variable like {id} in the example above you can do 40 | 41 | ```go 42 | // Render returns every title 43 | func (pv *PostView) Render() vecty.ComponentOrHTML { 44 | id := router.GetNamedVar(pv)["id"] 45 | return elem.Div( 46 | vecty.Text(id), 47 | ) 48 | } 49 | ``` 50 | 51 | ### Other features 52 | 53 | ##### Navigation through links 54 | 55 | ```go 56 | func (c *component) Render() vecty.ComponentOrHTML { 57 | return elem.Span( 58 | router.Link("/my/route", "click here", router.LinkOptions{}), 59 | ) 60 | } 61 | ``` 62 | 63 | ##### Programatically navigate to a route 64 | 65 | ```go 66 | router.Redirect("/my/route") 67 | ``` 68 | 69 | ### Status 70 | 71 | Currently vecty-router does not fallback to hash routing if the History API is not on your browser. 72 | It also calls vecty.Rerender on all routes whenever a route changes. It should/will do its own deducing of whether to call rerender on a route or not based on route matches and whether it's already mounted or not. 73 | 74 | ### Alternatives 75 | 76 | - https://github.com/go-humble/router 77 | -------------------------------------------------------------------------------- /router.go: -------------------------------------------------------------------------------- 1 | package router 2 | 3 | import ( 4 | "regexp" 5 | "strings" 6 | "syscall/js" 7 | 8 | fmt "github.com/cathalgarvey/fmtless" 9 | "github.com/hexops/vecty" 10 | ) 11 | 12 | var routes = []*Route{} 13 | var hasNamedVar = regexp.MustCompile("{[^/]+}") 14 | 15 | // Route keeps track of the component and the route it's meant to be matched against. 16 | // so when a the URL of the browser changes (pushState), we can check whether we need to render it or not. 17 | type Route struct { 18 | vecty.Core 19 | pattern string 20 | c vecty.Component 21 | p *regexp.Regexp 22 | } 23 | 24 | // NewRouteOpts let you specify route matching options, such as exact match. 25 | type NewRouteOpts struct { 26 | ExactMatch bool 27 | } 28 | 29 | // NewRoute takes a pattern and a component, if the pattern matches the 30 | // current URL, then it returns the component, otherwise it returns 31 | // an EmptyComponent. 32 | func NewRoute(pattern string, c vecty.Component, opts NewRouteOpts) *Route { 33 | r := &Route{ 34 | pattern: pattern, 35 | c: c, 36 | } 37 | 38 | routePattern := pattern 39 | 40 | if hasNamedVar.MatchString(pattern) { 41 | routePattern = hasNamedVar.ReplaceAllString(pattern, "([^/]+)") 42 | } 43 | 44 | if opts.ExactMatch { 45 | routePattern = fmt.Sprintf("^%v$", routePattern) 46 | } 47 | 48 | r.p = regexp.MustCompile(routePattern) 49 | 50 | register(r) 51 | 52 | return r 53 | } 54 | 55 | // Render renders the underlying component or EmptyComponent if route does not match 56 | func (r *Route) Render() vecty.ComponentOrHTML { 57 | path := pathname() 58 | 59 | if r.p.MatchString(path) { 60 | return r.c 61 | } 62 | 63 | return nil 64 | } 65 | 66 | // GetNamedVar returns the parsed named variables from a URL. 67 | // If you did NewRoute("/blog/{id}", someComponent{}). 68 | // Then you can do GetNamedVar(someComponent{}) 69 | // and get a map like this: {"id": "id-var"} 70 | func GetNamedVar(c vecty.Component) map[string]string { 71 | vars := map[string]string{} 72 | 73 | var givenRoute *Route 74 | for _, r := range routes { 75 | if r.c == c { 76 | givenRoute = r 77 | break 78 | } 79 | } 80 | 81 | if givenRoute == nil || givenRoute.p == nil { 82 | return vars 83 | } 84 | 85 | // extract the named vars from url: "/users/{id}/{dog}" => ["{id}", "{dog}"] 86 | namedVars := hasNamedVar.FindAllString(givenRoute.pattern, -1) 87 | 88 | // remove the surrounding brackets from each named var 89 | for i := 0; i < len(namedVars); i++ { 90 | namedVars[i] = strings.Replace( 91 | strings.Replace(namedVars[i], "{", "", 1), 92 | "}", 93 | "", 94 | 1, 95 | ) 96 | } 97 | 98 | namedValues := givenRoute.p.FindAllStringSubmatch(pathname(), -1)[0][1:] 99 | 100 | for i := 0; i < len(namedVars); i++ { 101 | vars[namedVars[i]] = namedValues[i] 102 | } 103 | 104 | return vars 105 | } 106 | 107 | // pathname gets the relative pathname from the browser. 108 | func pathname() string { 109 | return js.Global().Get("location").Get("pathname").String() 110 | } 111 | 112 | func register(r *Route) { 113 | routes = append(routes, r) 114 | } 115 | 116 | func refreshRoutes() { 117 | for _, r := range routes { 118 | vecty.Rerender(r) 119 | } 120 | if nf != nil { 121 | vecty.Rerender(nf) 122 | } 123 | } 124 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. --------------------------------------------------------------------------------