Skip to content

Commit 9aa8433

Browse files
jonas-jonasvinckraeneasr
authored
feat: add docs for ory elements (#2198)
Co-authored-by: Vincent <[email protected]> Co-authored-by: hackerman <[email protected]>
1 parent 2f4be2c commit 9aa8433

File tree

153 files changed

+5966
-1487
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

153 files changed

+5966
-1487
lines changed

docs/ecosystem/projects.mdx

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,17 @@ enterprise identity providers. It’s modular, supports your preferred database,
8484
data and privacy. Built for flexibility and scale, Ory Polis handles as many tenants and identity providers as your business
8585
demands. If you're delivering enterprise-grade SaaS and need SSO that just works, Ory Polis is the missing link.
8686

87+
## Ory Elements
88+
89+
![Ory Elements](https://raw.githubusercontent.com/ory/meta/master/static/logos/logo-elements.svg)
90+
91+
Ory Elements is a component library that allows you to build custom user interfaces for Ory self-service flows. It provides a set
92+
of pre-built components that can be easily integrated into your application, enabling you to create a seamless user experience
93+
while leveraging Ory's powerful authentication and identity management capabilities. Ory Elements is designed to work with Ory
94+
Kratos' self-service flows, such as login, registration, settings, verification, and recovery, as well as the OAuth2 consent flow.
95+
It allows you to customize the look and feel of your UI to match your brand and user experience requirements. You can use Ory
96+
Elements to build a custom UI that fits your application's design and user experience.
97+
8798
## All of Ory Open Source
8899

89100
```mdx-code-block
@@ -92,6 +103,32 @@ import { ProjectOverviewGraph } from "@site/src/pages/_assets/project-overview-g
92103
<ProjectOverviewGraph />
93104
```
94105

106+
```mdx-code-block
107+
import Mermaid from "@site/src/theme/Mermaid"
108+
109+
<Mermaid
110+
chart={`graph LR
111+
112+
User[User]
113+
Devices[Devices Web, Mobile, etc.]
114+
Oathkeeper[Ory / oathkeeper<br>Identity and Access Proxy IAP]
115+
Hydra[Ory / hydra<br>OAuth 2.0 and OpenID Connect]
116+
Kratos[Ory / kratos<br>Cloud native identity infrastructure]
117+
Keto[Ory / keto<br>Permission and Role Management]
118+
API[Your Code<br>API Endpoint 1 & API Endpoint 2]
119+
120+
User --> Devices
121+
Devices --> Oathkeeper
122+
123+
Oathkeeper -->|protects| API
124+
Oathkeeper -->|authenticates credentials with| Hydra
125+
User -->|Registers, log in, manages profiles, ...| Kratos
126+
Oathkeeper --> Kratos
127+
Oathkeeper -->|checks permissions with| Keto
128+
`}
129+
width="100%" />
130+
```
131+
95132
If you were to use the full Ory Ecosystem, it would probably look something like this. Keep in mind that any component shown here
96133
can be replaced or removed, depending on your use case.
97134

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
%% AUTOGENERATED - DO NOT EDIT
2+
graph LR
3+
ui-white --> brand-600
4+
ui-white --> interface-background-default-primary
5+
ui-white --> interface-foreground-default-inverted
6+
ui-warning --> interface-background-validation-warning
7+
ui-warning --> interface-border-validation-warning
8+
ui-warning --> interface-foreground-validation-warning
9+
ui-transparent --> interface-background-default-none
10+
ui-transparent --> interface-border-default-none
11+
ui-success --> interface-background-validation-success
12+
ui-success --> interface-border-validation-success
13+
ui-success --> interface-foreground-validation-success
14+
ui-danger --> interface-background-validation-danger
15+
ui-danger --> interface-border-validation-danger
16+
ui-danger --> interface-foreground-validation-danger
17+
ui-900 --> brand-500
18+
ui-900 --> interface-background-default-inverted
19+
ui-900 --> interface-foreground-default-primary
20+
ui-800 --> brand-950
21+
ui-800 --> interface-background-default-inverted-hover
22+
ui-700 --> brand-400
23+
ui-700 --> interface-border-default-inverted
24+
ui-700 --> interface-foreground-default-secondary
25+
ui-600 --> brand-900
26+
ui-500 --> brand-300
27+
ui-500 --> interface-foreground-default-tertiary
28+
ui-50 --> brand-50
29+
ui-50 --> interface-background-default-primary-hover
30+
ui-50 --> interface-background-default-secondary
31+
ui-400 --> brand-800
32+
ui-400 --> interface-foreground-disabled-on-disabled
33+
ui-300 --> brand-200
34+
ui-300 --> interface-background-default-tertiary-hover
35+
ui-300 --> interface-border-default-primary
36+
ui-300 --> interface-border-disabled-disabled
37+
ui-300 --> interface-foreground-disabled-disabled
38+
ui-200 --> brand-700
39+
ui-200 --> interface-background-default-secondary-hover
40+
ui-200 --> interface-background-default-tertiary
41+
ui-200 --> interface-background-disabled-disabled
42+
ui-100 --> brand-100
43+
interface-foreground-disabled-on-disabled --> button-primary-foreground-disabled
44+
interface-foreground-disabled-on-disabled --> button-secondary-foreground-disabled
45+
interface-foreground-disabled-on-disabled --> button-social-foreground-disabled
46+
interface-foreground-disabled-on-disabled --> input-foreground-disabled
47+
interface-foreground-disabled-disabled --> button-link-disabled-disabled
48+
interface-foreground-default-tertiary --> button-link-default-secondary-hover
49+
interface-foreground-default-tertiary --> input-foreground-tertiary
50+
interface-foreground-default-secondary --> button-link-default-secondary
51+
interface-foreground-default-secondary --> button-secondary-foreground-hover
52+
interface-foreground-default-secondary --> button-social-foreground-hover
53+
interface-foreground-default-secondary --> input-foreground-secondary
54+
interface-foreground-default-primary --> button-link-brand-brand-hover
55+
interface-foreground-default-primary --> button-link-default-primary
56+
interface-foreground-default-primary --> button-secondary-foreground-default
57+
interface-foreground-default-primary --> button-social-foreground-default
58+
interface-foreground-default-primary --> checkbox-foreground-default
59+
interface-foreground-default-primary --> input-foreground-primary
60+
interface-foreground-default-primary --> ory-foreground-default
61+
interface-foreground-default-primary --> radio-foreground-default
62+
interface-foreground-default-inverted --> button-social-foreground-generic-provider
63+
interface-foreground-brand-primary --> button-link-brand-brand
64+
interface-foreground-brand-primary --> button-link-default-primary-hover
65+
interface-foreground-brand-primary --> toggle-foreground-default
66+
interface-foreground-brand-on-secondary --> button-identifier-foreground-default
67+
interface-foreground-brand-on-secondary --> button-identifier-foreground-hover
68+
interface-foreground-brand-on-primary --> button-primary-foreground-default
69+
interface-foreground-brand-on-primary --> button-primary-foreground-hover
70+
interface-foreground-brand-on-primary --> checkbox-foreground-checked
71+
interface-foreground-brand-on-primary --> radio-foreground-checked
72+
interface-foreground-brand-on-primary --> toggle-foreground-checked
73+
interface-border-disabled-disabled --> button-primary-border-disabled
74+
interface-border-disabled-disabled --> button-secondary-border-disabled
75+
interface-border-disabled-disabled --> button-social-border-disabled
76+
interface-border-disabled-disabled --> input-border-disabled
77+
interface-border-default-primary --> button-secondary-border-default
78+
interface-border-default-primary --> button-secondary-border-hover
79+
interface-border-default-primary --> button-social-border-default
80+
interface-border-default-primary --> button-social-border-hover
81+
interface-border-default-primary --> checkbox-border-checkbox-border-default
82+
interface-border-default-primary --> form-border-default
83+
interface-border-default-primary --> input-border-default
84+
interface-border-default-primary --> input-border-hover
85+
interface-border-default-primary --> ory-border-default
86+
interface-border-default-primary --> radio-border-default
87+
interface-border-default-primary --> toggle-border-default
88+
interface-border-default-none --> button-primary-border-default
89+
interface-border-default-none --> button-primary-border-hover
90+
interface-border-default-none --> button-social-border-generic-provider
91+
interface-border-default-none --> toggle-border-checked
92+
interface-border-brand-brand --> button-identifier-border-border-default
93+
interface-border-brand-brand --> button-identifier-border-border-hover
94+
interface-border-brand-brand --> checkbox-border-checkbox-border-checked
95+
interface-border-brand-brand --> input-border-focus
96+
interface-border-brand-brand --> radio-border-checked
97+
interface-background-disabled-disabled --> button-primary-background-disabled
98+
interface-background-disabled-disabled --> button-secondary-background-disabled
99+
interface-background-disabled-disabled --> button-social-background-disabled
100+
interface-background-disabled-disabled --> input-background-disabled
101+
interface-background-default-secondary --> checkbox-background-default
102+
interface-background-default-secondary --> radio-background-default
103+
interface-background-default-secondary --> toggle-background-default
104+
interface-background-default-primary-hover --> button-secondary-background-hover
105+
interface-background-default-primary-hover --> button-social-background-hover
106+
interface-background-default-primary-hover --> input-background-hover
107+
interface-background-default-primary --> button-secondary-background-default
108+
interface-background-default-primary --> button-social-background-default
109+
interface-background-default-primary --> form-background-default
110+
interface-background-default-primary --> input-background-default
111+
interface-background-default-primary --> ory-background-default
112+
interface-background-default-inverted --> button-social-background-generic-provider
113+
interface-background-brand-secondary-hover --> button-identifier-background-hover
114+
interface-background-brand-secondary --> button-identifier-background-default
115+
interface-background-brand-primary-hover --> button-primary-background-hover
116+
interface-background-brand-primary --> button-primary-background-default
117+
interface-background-brand-primary --> checkbox-background-checked
118+
interface-background-brand-primary --> radio-background-checked
119+
interface-background-brand-primary --> toggle-background-checked
120+
brand-950 --> interface-foreground-brand-on-secondary
121+
brand-500 --> interface-background-brand-primary
122+
brand-500 --> interface-border-brand-brand
123+
brand-500 --> interface-foreground-brand-primary
124+
brand-50 --> interface-background-brand-secondary
125+
brand-50 --> interface-foreground-brand-on-primary
126+
brand-50 --> interface-foreground-brand-secondary
127+
brand-400 --> interface-background-brand-primary-hover
128+
brand-100 --> interface-background-brand-secondary-hover
129+

0 commit comments

Comments
 (0)