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.

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

Jump to bottom

docs: add example of actual authenticated state in example app #231

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

docs: add example of actual authenticated state in example app #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
afa93e9
docs: add example of actual authenticated state in example app
adamstankiewicz Apr 6, 2022
eb34582
build: adjust ci workflow
adamstankiewicz Apr 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
@@ -1,5 +1,5 @@
name: Default CI
on: [push, pull_request]
on: [pull_request]
jobs:
tests:
runs-on: ubuntu-latest
Expand Down
112 changes: 63 additions & 49 deletions example/index.js
View file
Open in desktop
Expand Up @@ -6,62 +6,76 @@ import ReactDOM from 'react-dom';
import { AppContext, AppProvider } from '@edx/frontend-platform/react';
import { initialize, getConfig, subscribe, APP_READY } from '@edx/frontend-platform';
import Header, { StudioHeader } from '@edx/frontend-component-header';
import { Stack } from '@edx/paragon';

import './index.scss';

subscribe(APP_READY, () => {
ReactDOM.render(
<AppProvider>
{/* We can fake out authentication by including another provider here with the data we want */}
<AppContext.Provider value={{
authenticatedUser: null,
config: getConfig(),
}}>
<Header />
</AppContext.Provider>
<h5 className="mt-2 mb-5">Logged out state</h5>
<Stack gap={5}>
{/* We can fake out authentication by including another provider here with the data we want, an unauthenticated user. */}
<div>
<h4>Logged out state</h4>
<AppContext.Provider value={{
authenticatedUser: null,
config: getConfig(),
}}>
<Header />
</AppContext.Provider>
</div>

{/* We can fake out authentication by including another provider here with the data we want */}
<AppContext.Provider value={{
authenticatedUser: {
userId: '123abc',
username: 'testuser',
roles: [],
administrator: false,
},
config: getConfig(),
}}>
<Header />
</AppContext.Provider>
<h5 className="mt-2 mb-5">Logged in state</h5>
<AppContext.Provider value={{
authenticatedUser: {
userId: '123abc',
username: 'testuser',
roles: [],
administrator: false,
},
config: getConfig(),
}}>
<StudioHeader
number="run123"
org="testX"
title="Course Name"
isHiddenMainMenu={false}
mainMenuDropdowns={[
{
id: 'content-dropdown',
buttonTitle: 'Content',
items: [{
href: '#',
title: 'Outline',
}],
},
]}
outlineLink="#"
/>
</AppContext.Provider>
<h5 className="mt-2">Logged in state for Studio header</h5>
{/* We can fake out authentication by including another provider here with the data we want, an authenticated user. */}
<AppContext.Provider value={{
authenticatedUser: {
userId: '123abc',
username: 'testuser',
roles: [],
administrator: false,
},
config: getConfig(),
}}>
{/* Default header */}
<div>
<h4>Logged in state</h4>
<Header />
</div>

{/* Studio header */}
<div>
<h4>Logged in state for Studio header</h4>
<StudioHeader
number="run123"
org="testX"
title="Course Name"
isHiddenMainMenu={false}
mainMenuDropdowns={[
{
id: 'content-dropdown',
buttonTitle: 'Content',
items: [{
href: '#',
title: 'Outline',
}],
},
]}
outlineLink="#"
/>
</div>
</AppContext.Provider>

{/* Default header, using actual `AppContext` values */}
<div>
<h4>Actual logged in state</h4>
<Header />
<p className="small mt-2 px-2">
If you are authenticated with the LMS (<code>edx-platform</code>), you will see the logged in state. Additionally, if
you are an enterprise learner, you should see a custom logo and Dashboard links
that direct you to http://localhost:8734 (<code>frontend-app-learner-portal-enterprise</code>). Otherwise,
you will see the logged out state.
</p>
</div>
</Stack>
</AppProvider>,
document.getElementById('root'),
);
Expand Down