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
1379120b
Commit
1379120b
authored
Aug 07, 2019
by
Kyle Keating
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add the experimental focus feature to the docs
parent
b104d018
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
39 additions
and
4 deletions
+39
-4
config.rst
docs/publishers/config.rst
+39
-4
No files found.
docs/publishers/config.rst
View file @
1379120b
...
@@ -365,10 +365,6 @@ loads.
...
@@ -365,10 +365,6 @@ loads.
.. option:: externalContainerSelector
.. option:: externalContainerSelector
.. warning::
This is an experimental API and may change in future.
``string``. A CSS selector specifying the containing element into which the
``string``. A CSS selector specifying the containing element into which the
sidebar iframe will be placed.
sidebar iframe will be placed.
...
@@ -385,6 +381,45 @@ loads.
...
@@ -385,6 +381,45 @@ loads.
where annotations are located on the page relative to the current scroll
where annotations are located on the page relative to the current scroll
position.
position.
.. warning::
The :option:`externalContainerSelector`
setting is currently still experimental and may change in the future.
.. option:: focus
``Object``. A structured object that defines a focused filter set for the available
annotations on a page. When this object is passed to the config, the sidebar will add
a UI button element that the user can toggle on or off to apply the filtered set of
annotations defined by this ``focus`` object. This structure may define a particular
``user`` to focus on. Currently, only the ``user`` type is supported, but others may
be added later.
.. note::
The focus ``user`` is not necessarily the same user viewing the sidebar.
For example:
.. code-block:: javascript
window.hypothesisConfig = function () {
return {
focus: {
user: {
// required
username: "foobar1234",
// optional
displayName: "Foo Bar",
authority: "example.com",
}
}
};
};
.. warning::
The :option:`focus`
setting is currently still experimental and may change in the future.
Asset and Sidebar App Location
Asset and Sidebar App Location
##############################
##############################
...
...
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