Skip to content

Update readme.md with correct instantiation and module import #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update readme.md with correct instantiation and module import #110

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64029eb
Update readme.md
ZeroPie Oct 13, 2020
04adea2
Update readme.md
ZeroPie Oct 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion packages/library/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,41 @@ $ yarn add lab.js # (alternatively)

The idea underlying this little library is that studies are assembled from individual _components_. The simplest example might be the following:

study.js
```
// import the module you want to use
import { html } from 'lab.js'

// Define a component
const hello = new lab.html.Screen({
const hello = new html.Screen({
content: 'Hello world!'
})

// Run it
hello.run()
```

Include the script in your index.html
```
<head>
...
</head>
<body>
<div class="container fullscreen" id="container">
<main class="content-vertical-center content-horizontal-center" data-labjs-section="main">
<p>
<strong>Preparing experiment</strong><br />
<span class="text-muted">please wait a moment</span>
</p>
</div>
...
<script src="study.js"></script>
</main>
</div>
</body>
</html>
```

Each component can [provide information to participants](https://labjs.readthedocs.io/en/latest/reference/html.html), as in the above example, or [add structure to the study](https://labjs.readthedocs.io/en/latest/reference/flow.html). Besides the content, components [coordinate user events](https://labjs.readthedocs.io/en/latest/reference/core.html#options.responses) and [collect data](https://labjs.readthedocs.io/en/latest/reference/data.html), providing the central functionality for any browser-based study. Every component can also be extended using [hooks](https://labjs.readthedocs.io/en/latest/reference/core.html#event-api) which allow custom code to be added at any point within the study.

## Further information
Expand Down