Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
C
coopwire-hypothesis
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
孙灵跃 Leon Sun
coopwire-hypothesis
Commits
796177f0
Unverified
Commit
796177f0
authored
Mar 08, 2017
by
Sean Hammond
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Document the window.hypothesisConfig function
parent
a805e317
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
21 additions
and
0 deletions
+21
-0
config.md
docs/config.md
+21
-0
No files found.
docs/config.md
View file @
796177f0
Configuring the client
Configuring the client
======================
======================
### Configuring the client using JSON
The Hypothesis client can be configured by providing a JSON config object in
The Hypothesis client can be configured by providing a JSON config object in
the body of the hosting page:
the body of the hosting page:
...
@@ -13,10 +15,29 @@ the body of the hosting page:
...
@@ -13,10 +15,29 @@ the body of the hosting page:
<script
async
src=
"https://hypothes.is/embed.js"
></script>
<script
async
src=
"https://hypothes.is/embed.js"
></script>
```
```
Not all configuration settings can be set in this way, some must be
[
set using JavaScript
](
#configuring-the-client-using-javascript
)
(
see
below).
**N.B.**
The body of the
`.js-hypothesis-config`
tag must be
[
valid
**N.B.**
The body of the
`.js-hypothesis-config`
tag must be
[
valid
JSON](http://jsonlint.com/) -- invalid JSON will cause the entire config object
JSON](http://jsonlint.com/) -- invalid JSON will cause the entire config object
to be ignored.
to be ignored.
### Configuring the client using JavaScript
Alternatively, the Hypothesis client can be configured from the hosting page by
providing a JavaScript function named
`window.hypothesisConfig`
that returns
a configuration object. Some configuration settings (for example settings that
register callback or event handler functions) can _only_ be set from
JavaScript:
```
html
window.hypothesisConfig = function () {
return {
"openSidebar": true
};
};
```
Config keys
Config keys
-----------
-----------
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment