Skip to content

Commit d6b9cfd

Browse files
ebidelebidel
committed
- Adding toolkit submodule
- Adding out of date include (temporary) - Few updates to remove toolkitchensink
1 parent 52e7184 commit d6b9cfd

5 files changed

Lines changed: 23 additions & 26 deletions

File tree

‎.gitmodules‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "toolkit"]
2+
path = toolkit
3+
url = [email protected]:toolkitchen/toolkit.git

‎_includes/outofdate.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<p class="alert">
2+
<b>Heads up</b>: This document is out of date and describes an older of the API.
3+
We're working on updating it.
4+
</p>

‎getting-the-code.md‎

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,49 +5,36 @@ title: Getting the Code
55

66
<p class="alert">
77
<strong>Browser requirements</strong>: {{site.project_title}} will eventually support all major "evergreen"
8-
(auto-updating) browsers, it currently requires a WebKit-based browser
9-
such as Chrome or Safari.
8+
(auto-updating) browsers, it currently requires a WebKit-based browser such as Chrome or Safari.
109
</p>
1110

1211
## Bring on the code!
1312

1413
You can recursively clone and initialize all of its submodules with a single git command.
1514

16-
**To clone toolkitchensink:**
15+
**To clone toolkit:**
1716

18-
git clone git://github.com/toolkitchen/toolkitchensink.git --recursive
17+
git clone git://github.com/toolkitchen/toolkit.git --recursive
1918

20-
This creates the following top-level directories in `toolkitchensink/`,
21-
each a submodule:
19+
This creates a `toolkit/` folder with the following top-level files and folders:
2220

23-
- **toolkit/** — Contains the core Toolkit kernel, a set of components,
24-
and the platform shims and polyfills.
25-
- **pantry/** — Extra components and wrappers for third-party code.
26-
- **projects/** — Projects that use, enhance, or demonstrate Toolkit
27-
technologies.
28-
29-
The `toolkit/` folder contains the following sub-folders:
30-
31-
- **platform/** — Contains the platform shims and polyfills.
32-
- **components/** — Contains the [Toolkit kernel](toolkit-kernel-explainer.html) (g-component.html) and
33-
the initial set of components.
34-
- **getting_started/** —A starter project.
35-
- **test/** — Test cases.
36-
- **third-party/** — Testing libraries.
37-
- **workbench/**— Examples of using Toolkit components.
21+
- **components/** — Initial set of example components.
22+
- **platform/** — Submodule which contains the platform shims and polyfills.
23+
- **test/** — Test cases.
24+
- **workbench/** — Examples of using the Toolkit components in `components/`.
25+
- **toolkit.js** — The [Toolkit kernel](toolkit-kernel-explainer.html)
3826

3927
## Test your environment
4028

4129
To check that your development environment is ready, start a local web
4230
server and run one of the included sample projects:
4331

44-
1. Start a local web server with the `toolkitchensink/` folder as the
45-
web root.
46-
2. In your browser, navigate to
32+
1. Start a local web server with the `toolkit/` folder as the web root.
33+
2. In your browser, navigate to
4734
[http://localhost:8000/toolkit/workbench/menu.html](http://localhost:8000/toolkit/workbench/menu.html).
4835
You should see a menu of items, as shown below.
4936

50-
<iframe src="/toolkitchensink/toolkit/workbench/menu.html" style="width: 270px;height:280px;border:none;"></iframe>
37+
<iframe src="/toolkit/workbench/menu.html" style="width: 270px;height:280px;border:none;"></iframe>
5138

5239
### Updating {{site.project_title}} submodules
5340

‎toolkit‎

Submodule toolkit added at 964d26f

‎toolkit-kernel-explainer.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ layout: default
33
title: Toolkit kernel
44
---
55

6+
{% include outofdate.html %}
7+
68
The Toolkit _kernel_ provides a thin layer of code that expresses the Toolkit
79
opinion, and provides the sugar that all components use. The kernel code is
810
provided by a file named `g-component.html`. A web component that depends on the
@@ -129,7 +131,7 @@ is not publicly callable:
129131
Note the following:
130132

131133
1. There can be only one `publish` block per definition.
132-
2. Published properties are actually stored on the **protected** prototype, then they are forwarded to the public prototype. In other words, `blueColor`(?) is different from `clickColor` only because there is a public getter/setter pair to access it.
134+
2. Published properties are actually stored on the **protected** prototype, then they are forwarded to the public prototype.
133135
3. Published methods still operate in protected scope: the properties you can access via `this` are no different from methods declared outside the publish block.
134136

135137
Bottom line: when building components use `this` naturally and declare properties and methods as you like. Then, if you happen to create API you want to make public, you just move it into the `publish` block.

0 commit comments

Comments
 (0)