Skip to content
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.

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

Add documentation for responsive app setup #717

Merged
merged 24 commits into from
Aug 23, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
877ce76
Add docu for responsive app setup
jesusreal Aug 2, 2019
612973f
Merge branch 'master' into document_responsive_app_setup
maxmarkus Aug 6, 2019
68dea31
Apply suggestions from code review
jesusreal Aug 7, 2019
e0690a2
Apply suggestions from code review
jesusreal Aug 7, 2019
700f302
Merge branch 'master' into document_responsive_app_setup
maxmarkus Aug 7, 2019
4a567bc
Update luigi-ux-features.md
JohannesDoberer Aug 8, 2019
ad6f4f1
Merge branch 'master' into document_responsive_app_setup
pekura Aug 9, 2019
04f303c
Merge branch 'master' into document_responsive_app_setup
maxmarkus Aug 19, 2019
4b58108
Merge branch 'master' into document_responsive_app_setup
jesusreal Aug 22, 2019
1006316
Merge branch 'master' into document_responsive_app_setup
jesusreal Aug 22, 2019
70e5329
Merge branch 'document_responsive_app_setup' of github.com:jesusreal/…
maxmarkus Aug 22, 2019
7ef9b82
Add debugging lines for travis issues
jesusreal Aug 22, 2019
42ca949
Merge branch 'document_responsive_app_setup' of github.com:jesusreal/…
maxmarkus Aug 22, 2019
bc27dfb
state-helpers debug
maxmarkus Aug 22, 2019
25cf8fa
state helper test
maxmarkus Aug 22, 2019
e64e684
debugging, disable cache
maxmarkus Aug 22, 2019
cab93f0
find build-dir
maxmarkus Aug 22, 2019
cf7778f
debug cat
maxmarkus Aug 22, 2019
60ded7c
debug state path
maxmarkus Aug 22, 2019
e918291
debug with cache
maxmarkus Aug 22, 2019
5173372
debug cache node_modules
maxmarkus Aug 22, 2019
825a299
git status
maxmarkus Aug 22, 2019
cec1ec3
core api docs
maxmarkus Aug 22, 2019
fc2518f
cleanup
maxmarkus Aug 23, 2019
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
9 changes: 7 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ dist: trusty
install: skip
cache:
directories:
- $TRAVIS_BUILD_DIR
- $TRAVIS_BUILD_DIR/node_modules
- $TRAVIS_BUILD_DIR/client
- $TRAVIS_BUILD_DIR/client/node_modules
- $TRAVIS_BUILD_DIR/core/public
- $TRAVIS_BUILD_DIR/core/node_modules
- $TRAVIS_BUILD_DIR/core/examples/luigi-sample-angular/node_modules
- $TRAVIS_BUILD_DIR/cypress-binary-cache
- $HOME/.cache/Cypress
notifications:
slack:
Expand All @@ -15,7 +21,6 @@ jobs:
- stage: 'Precache'
name: 'Install and build'
script:
- pwd && ls $TRAVIS_BUILD_DIR
- export CYPRESS_CACHE_FOLDER=$TRAVIS_BUILD_DIR/cypress-binary-cache
- npm i -g lerna
- lerna bootstrap --ci --ignore "*luigi-sample-vue"
Expand Down
4 changes: 2 additions & 2 deletions docs/luigi-core-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ Tells Luigi that the configuration has been changed. Luigi will update the appli

##### Parameters

- `scope` **...[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** one or more scope selectors specifying what parts of the configuration were changed. If no scope selector is provided the whole configuration is considered changed.<p>
These scope selectors are supported:
- `scope` **...[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** one or more scope selectors specifying what parts of the configuration were changed. If no scope selector is provided, the whole configuration is considered changed.<p>
The supported scope selectors are:
<p>
<ul>
<li><code>navigation</code>: the navigation part of the configuration was changed. This includes navigation nodes, the context switcher, the product switcher and the profile menu.</li>
Expand Down
13 changes: 13 additions & 0 deletions docs/luigi-ux-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,16 @@ By default, the Luigi content, including the top navigation, the left navigation
However, you can render the Luigi content in any other HTML container. It can be useful if you want to add a header or a footer on top of the Luigi content. To use this feature, add the `luigi-app-root` custom HTML attribute to the HTML tag in which you want to render the Luigi content.

>**NOTE:** If you render the Luigi content in a custom container, the container is positioned relatively when you apply your own CSS. Also, set the height of the Luigi custom container either in **px** or **vh**.


### Responsive application setup

You can quickly adjust the Luigi application to improve user experience on mobile devices, such as smartphones or tablets. Here are some examples:

* Add the following line to your `index.html` file for the Luigi application to render well on a mobile device:

```html
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1">
```

* Define and apply [responsiveNavigation](./general-settings.md) settings to make the left navigation responsive.
2 changes: 2 additions & 0 deletions scripts/docuCheck.sh
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ validateMdChanges() {
fi
}

echoe "git status"
git status

# add all folders that are containing documentation steps
for FOLDER in "${LUIGI_FOLDERS[@]}"
Expand Down