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

docs: add kolibri accessible component lib #624

Merged
merged 1 commit into from
Jan 11, 2023
Merged

Conversation

deleonio
Copy link
Contributor

@deleonio deleonio commented Oct 18, 2022

We have published a new full accessible web component library: https://public-ui.github.io/

@deleonio deleonio requested a review from andrico1234 as a code owner October 18, 2022 15:25
@deleonio
Copy link
Contributor Author

deleonio commented Nov 9, 2022

Hello @andrico1234,

could you review this PR?

@andrico1234
Copy link
Collaborator

andrico1234 commented Nov 18, 2022

Thanks for contributing the Kolibri to the Open UI design system catalog

As per the Open UI site, a design system added to the site should satisfy many of the following points:

✅ support designers and developers
✅ support multiple platforms and frameworks
✅ support accessible users
✅ support small and enterprise projects
✅ demonstrate organic adoption in a wide community
✅ demonstrate significant real-world usage
✅ demonstrate deep thought and debate by many experienced minds

Are you able to provide a few short sentences on how Kolibri satisfies the above criteria?

I'll be happy to approve after 😄

@deleonio
Copy link
Contributor Author

deleonio commented Dec 15, 2022

@andrico1234 We have answered ;-).

support designers and developers

We have developed an accessible Web Component Lib, where the semantic HTML is completely decoupled from the design CSS.
For developers, the small-part Web Components are interesting, which can be reused virtually in any other design system.
For designers it is exciting, because they can create so called themes on the accessible components. The advantage is the maximum freedom with CSS - instead of depending only on CSS properties or design tokens.

support multiple platforms and frameworks

Yes, by means of the Web Components we support all modern platforms and frameworks (Pure HTML, React, Preact, Angular, Solid, Next.js, Astro, etc.).

See: https://public-ui.github.io/?path=/docs/frameworks--page

support accessible users

This is our vision. We've built the whole lib from the ground up, starting with accessibility requirements, not design. All. Everything we do starts with the question: Is this accessible? And then we continue to look at how granular and flexible it can be reused. Design comes much later.

support small and enterprise projects

Our lib is suitable for the implementation of any size project.

demonstrate organic adoption in a wide community

Our lib is used to implement web-based citizen services of all types in Germany. The lib is published under the EUPL 1.2 of the European Union.

demonstrate significant real-world usage

Our mission: The HTML web standard is specified very "openly" in order to be as durable and robust as possible. Therefore, it often happens that HTML compositions are not easily accessible, semantic and valid. KoliBri builds directly on the web standards of the W3C (framework-agnostic), is a generic reference implementation of the WCAG standard and the BITV for accessibility and implemented as a multi-theme capable presentation layer. There is no technical reference and no data transfer functionalities. This makes KoliBri equally reusable for the realization of static websites as well as dynamic web applications of different corporate designs and style guides and therefore very interesting for open source.

There are more and more laws coming in the future to improve accessibility. On for the private sector.

demonstrate deep thought and debate by many experienced minds

Our library was developed by a broad team of architects, accessibility experts and UX designers over now more than 2,5 years. The ITZBund is maintainer of the lib in the whole community.

Thanks and We wish you a Merry Christmas 🎄.

@deleonio
Copy link
Contributor Author

deleonio commented Jan 1, 2023

First of all, we wish you a Happy new Year!

I'm making a new comment here because I'm not sure if you've been notified of our new information in this pull request.

Copy link
Member

@gregwhitworth gregwhitworth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the addition of this!! I'll leave it for @andrico1234 to approve and merge.

@andrico1234
Copy link
Collaborator

Thanks so much for this @deleonio , happy to merge!

@andrico1234 andrico1234 merged commit d8d5f9e into openui:main Jan 11, 2023
gregwhitworth added a commit that referenced this pull request Feb 27, 2023
* initial astro commit

* minor config change

* move over sources

* fix prettier formatting

* rename files and create layout

* move to markdown

* migrate markdown file

* get navigation working

* fix routing for pages

* update the documentation

* more fixes to styling

* get layouts working for all pages

* improve styles even more

* get build working

* fix image

* fix navigation order

* get navigation working

* add favicon

* fix page title

* fix menu sorting

* fix lighthouse issues

* update node version

* minors to styles

* override gatsby build config

* typo

* fix navigation styles

* remove unused dependencies, remove render blocking resources, prefetch resources

* reduce font flashing, fix markup issues

* fix build from breaking

* test removing prefetch

* rmeove compression

* revert changes to config

* fix prefetch

* fix image paths

* Create 2022-12-01.md

* Update 2022-12-01.md

* Update 2022-12-01.md

* Update popup.research.explainer.mdx (#644)

Remove lingering mention of `popover=hint` for now.

* Popover target attribute updates (#647)

The `popovertoggletarget`, `popovershowtarget` and `popoverhidetarget` attributes will initially map to `aria-expanded`.

This has already been implemented in Chromium browsers.  HTML AAM PR to add this mapping to the spec: w3c/html-aam#446

* Create 2023-01-05.md

* Update 2023-01-05.md

* Create 2023-01-12.md

* docs: add kolibri accessible component lib (#624)

* Update 2023-01-12.md

* Create 2023-01-19.md

* Task: Add redirect for popup (#653)

* add redirect for popup

* refactor code

* let yarn do its thing

* revert formatting change

* add redirect comment

Co-authored-by: Andrico <andrico@animaapp.com>

* Update popover.research.explainer.mdx (#654)

* Update popover.research.explainer.mdx

* Update research/src/pages/popup/popover.research.explainer.mdx

Co-authored-by: Scott O'Hara <scottaohara@users.noreply.github.com>

Co-authored-by: Scott O'Hara <scottaohara@users.noreply.github.com>

* Create 2023-02-02.md

* fix layout issue

* fix interactions

* Update 2023-02-02.md

* Update 2023-02-02.md

* selectmenu is an element, code escape it (#660)

* update layout and remove stale content

* handle missing images

* minor fixes and redirects

* fix dead links

* Create 2023-02-16.md

* Update 2023-02-16.md

* Adjusted the home page to reflect the current reality and ensure the relationship between Open UI & the W3C is clear (#663)

* Create 2023-02-23.md

* minor improvements

* temporarily prevent refetch

* revert prefetch change

* Update 2023-02-23.md

* performance + a11y improvements

* remove Lora font family

---------

Co-authored-by: Andrico <andrico.karoulla@healthhero.com>
Co-authored-by: Greg Whitworth <865244+gregwhitworth@users.noreply.github.com>
Co-authored-by: Jhey Tompkins <jh3y@users.noreply.github.com>
Co-authored-by: Scott O'Hara <scottaohara@users.noreply.github.com>
Co-authored-by: Martin <6279703+deleonio@users.noreply.github.com>
Co-authored-by: Andrico <andrico@animaapp.com>
Co-authored-by: Tantek Çelik <blog@tantek.com>
gregwhitworth added a commit that referenced this pull request Feb 28, 2023
* [Site rewrite] Migrate site to astro (#606)

* initial astro commit

* minor config change

* move over sources

* fix prettier formatting

* rename files and create layout

* move to markdown

* migrate markdown file

* get navigation working

* fix routing for pages

* update the documentation

* more fixes to styling

* get layouts working for all pages

* improve styles even more

* get build working

* fix image

* fix navigation order

* get navigation working

* add favicon

* fix page title

* fix menu sorting

* fix lighthouse issues

* update node version

* minors to styles

* override gatsby build config

* typo

* fix navigation styles

* remove unused dependencies, remove render blocking resources, prefetch resources

* reduce font flashing, fix markup issues

* fix build from breaking

* test removing prefetch

* rmeove compression

* revert changes to config

* fix prefetch

* fix image paths

* Create 2022-12-01.md

* Update 2022-12-01.md

* Update 2022-12-01.md

* Update popup.research.explainer.mdx (#644)

Remove lingering mention of `popover=hint` for now.

* Popover target attribute updates (#647)

The `popovertoggletarget`, `popovershowtarget` and `popoverhidetarget` attributes will initially map to `aria-expanded`.

This has already been implemented in Chromium browsers.  HTML AAM PR to add this mapping to the spec: w3c/html-aam#446

* Create 2023-01-05.md

* Update 2023-01-05.md

* Create 2023-01-12.md

* docs: add kolibri accessible component lib (#624)

* Update 2023-01-12.md

* Create 2023-01-19.md

* Task: Add redirect for popup (#653)

* add redirect for popup

* refactor code

* let yarn do its thing

* revert formatting change

* add redirect comment

Co-authored-by: Andrico <andrico@animaapp.com>

* Update popover.research.explainer.mdx (#654)

* Update popover.research.explainer.mdx

* Update research/src/pages/popup/popover.research.explainer.mdx

Co-authored-by: Scott O'Hara <scottaohara@users.noreply.github.com>

Co-authored-by: Scott O'Hara <scottaohara@users.noreply.github.com>

* Create 2023-02-02.md

* fix layout issue

* fix interactions

* Update 2023-02-02.md

* Update 2023-02-02.md

* selectmenu is an element, code escape it (#660)

* update layout and remove stale content

* handle missing images

* minor fixes and redirects

* fix dead links

* Create 2023-02-16.md

* Update 2023-02-16.md

* Adjusted the home page to reflect the current reality and ensure the relationship between Open UI & the W3C is clear (#663)

* Create 2023-02-23.md

* minor improvements

* temporarily prevent refetch

* revert prefetch change

* Update 2023-02-23.md

* performance + a11y improvements

* remove Lora font family

---------

Co-authored-by: Andrico <andrico.karoulla@healthhero.com>
Co-authored-by: Greg Whitworth <865244+gregwhitworth@users.noreply.github.com>
Co-authored-by: Jhey Tompkins <jh3y@users.noreply.github.com>
Co-authored-by: Scott O'Hara <scottaohara@users.noreply.github.com>
Co-authored-by: Martin <6279703+deleonio@users.noreply.github.com>
Co-authored-by: Andrico <andrico@animaapp.com>
Co-authored-by: Tantek Çelik <blog@tantek.com>

* remove unused dependencies

---------

Co-authored-by: Andrico <karoulla.andrico@gmail.com>
Co-authored-by: Andrico <andrico.karoulla@healthhero.com>
Co-authored-by: Jhey Tompkins <jh3y@users.noreply.github.com>
Co-authored-by: Scott O'Hara <scottaohara@users.noreply.github.com>
Co-authored-by: Martin <6279703+deleonio@users.noreply.github.com>
Co-authored-by: Andrico <andrico@animaapp.com>
Co-authored-by: Tantek Çelik <blog@tantek.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants