Comments (11)
To keep things simple, the best solution is probably to use the existing alert style. Thoughts?
cc @ashygee @broccolini @emplums
from doctocat.
Over the summer, we had played around with the idea of a note/alert component similar to this:
https://theme-ui.com/getting-started
from doctocat.
We also discussed having different colors to represent different types of "alerts." Specifically, we discussed blue for information, yellow for warnings, and pink for protips.
from doctocat.
I guess alerts works the same way, except pink is for errors.
from doctocat.
I was reading some Figma documentation today and really liked their note component:
https://help.figma.com/hc/en-us/articles/360039823654-Download-the-Figma-Desktop-App
from doctocat.
Looks cool.
They also seem to have different types of notes:
https://help.figma.com/hc/en-us/articles/360039829154-Receive-Comment-Notifications-in-Slack
https://help.figma.com/hc/en-us/articles/360039829254-ProtoPie-and-Figma
And guessing this is the default box style:
https://help.figma.com/hc/en-us/articles/360039829154-Receive-Comment-Notifications-in-Slack
from doctocat.
Yeah! This style might be too bold for GitHub but I do like that it really stands out on the page and feels kinda slick. I think we could use something outside of the design system though for these notes since they do have a pretty specific purpose that differs from how we use Alerts in .com
from doctocat.
Latest design here: https://www.figma.com/file/qsKUZDH4xE8h6e7p7GBE8e/Doctocat-Extra-components?node-id=291%3A0
from doctocat.
@yaili What different types of alerts do we want to support? It'd be helpful if we could list them all out and assign them colors.
from doctocat.
@colebemis I think we'd have a warning/danger, alert, tip, and default (the blue one, Figma Docs calls it "note").
Would we want to align with names of our Primer components?
from doctocat.
Closed by #167
from doctocat.
Related Issues (20)
- Standardized examples in Doctocat HOT 1
- Border radius not present in example iframes
- background color error HOT 1
- Stale instructions HOT 2
- Add frontmatter variable to hide "Edit this page" links HOT 2
- Bump @primer/components to the latest version
- Implement `groupBy` functionality for checklists
- Add a built-in component maturity checklist
- Move away from deprecated @primer/react components
- Intermediate breakpoints causes the layout to break on pages with large snippets HOT 1
- Update doctocat to support React 18 HOT 1
- [Feature request] Do not hardcode the word `Primer` in the header component. HOT 1
- [Feature request] Allow customization of the "Edit on GitHub" links HOT 1
- [Feature request] A search page with all results listed HOT 1
- Build output SSRProvider warnings
- Accessibility analysis HOT 1
- Duplicated heading texts should have a unique ID to generate expected anchor link HOT 13
- Add a Dark/Light theme toggle button to the navbar HOT 4
- Test
- Documentation content vertical spacing HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from doctocat.