mirror of
https://github.com/primer/css.git
synced 2025-01-07 14:58:54 +03:00
Update lock
This commit is contained in:
parent
565f550bee
commit
e8a3b37f87
197
docs/content/components/layout.md
Normal file
197
docs/content/components/layout.md
Normal file
@ -0,0 +1,197 @@
|
|||||||
|
---
|
||||||
|
title: Layout
|
||||||
|
path: components/layout
|
||||||
|
status: Experimental
|
||||||
|
source: 'https://github.com/primer/css/tree/main/src/layout/layout.scss'
|
||||||
|
bundle: layout
|
||||||
|
---
|
||||||
|
|
||||||
|
<!--
|
||||||
|
|
||||||
|
Layout
|
||||||
|
======
|
||||||
|
|
||||||
|
Build responsive-friendly page layouts with 2 columns.
|
||||||
|
|
||||||
|
Use with .container-xx classes to limit the overall layout structure size.
|
||||||
|
|
||||||
|
## Elements:
|
||||||
|
|
||||||
|
- `Layout-main`
|
||||||
|
- `Layout-sidebar`
|
||||||
|
|
||||||
|
- `Layout-center-container-md`
|
||||||
|
- `Layout-center-container-lg`
|
||||||
|
- `Layout-center-container-xl`
|
||||||
|
|
||||||
|
Use `Layout-center-container-xx` to wrap `container-xx` elements inside
|
||||||
|
`Layout-main` so the content remains centered on the screen regardless
|
||||||
|
of the sidebar position.
|
||||||
|
|
||||||
|
|
||||||
|
## Modifiers:
|
||||||
|
|
||||||
|
### Sidebar position on desktop/large screens
|
||||||
|
|
||||||
|
- `Layout--right-sidebar` (default)
|
||||||
|
- `Layout--left-sidebar`
|
||||||
|
|
||||||
|
|
||||||
|
### Sidebar position on mobile/small screens
|
||||||
|
|
||||||
|
- `Layout--main-priority` (default)
|
||||||
|
- `Layout--sidebar-priority`
|
||||||
|
|
||||||
|
|
||||||
|
### Sidebar sizing
|
||||||
|
|
||||||
|
- Default: [md: 256px, lg: 296px, xl: 320px]
|
||||||
|
- `Layout--sidebar-narrow` [md: 240px, lg: 256px, xl: 296px]
|
||||||
|
- `Layout--sidebar-wide` [md: 296px, lg: 320px, xl: 344px]
|
||||||
|
|
||||||
|
|
||||||
|
### Column gutter
|
||||||
|
|
||||||
|
- Default: [md: 16px, lg: 24px, xl: 32px]
|
||||||
|
- `Layout--gutter-condensed` [md: 16px, lg: 16px, xl: 24px]
|
||||||
|
- `Layout--gutter-spacious` [md: 24px, lg: 32px, xl: 40px]
|
||||||
|
|
||||||
|
## Accessibility and keyboard navigation
|
||||||
|
|
||||||
|
Keyboard navigation follows the markup order. Decide carefully how the
|
||||||
|
focus order should be be by deciding whether `Layout-main` or `Layout-sidebar`
|
||||||
|
comes first in code. The code order won’t affect the visual position.
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h4>Default</h4>
|
||||||
|
|
||||||
|
<div class="Layout">
|
||||||
|
<div class="Layout-main">
|
||||||
|
main
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="Layout-sidebar">
|
||||||
|
sidebar
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h4>Condensed gutter</h4>
|
||||||
|
|
||||||
|
<div class="Layout Layout--gutter-condensed">
|
||||||
|
<div class="Layout-main">
|
||||||
|
main
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="Layout-sidebar">
|
||||||
|
sidebar
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h4>Spacious gutter</h4>
|
||||||
|
|
||||||
|
<div class="Layout Layout--gutter-spacious">
|
||||||
|
<div class="Layout-main">
|
||||||
|
main
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="Layout-sidebar">
|
||||||
|
sidebar
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h4>Narrow sidebar</h4>
|
||||||
|
|
||||||
|
<div class="Layout Layout--sidebar-narrow">
|
||||||
|
<div class="Layout-main">
|
||||||
|
main
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="Layout-sidebar">
|
||||||
|
sidebar
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h4>Wide sidebar</h4>
|
||||||
|
|
||||||
|
<div class="Layout Layout--sidebar-wide">
|
||||||
|
<div class="Layout-main">
|
||||||
|
main
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="Layout-sidebar">
|
||||||
|
sidebar
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h4>Layout within container</h4>
|
||||||
|
|
||||||
|
<div class="Layout container-xl">
|
||||||
|
<div class="Layout-main">
|
||||||
|
main
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="Layout-sidebar">
|
||||||
|
sidebar
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h4>Left-sidebar</h4>
|
||||||
|
|
||||||
|
<div class="Layout Layout--left-sidebar">
|
||||||
|
<div class="Layout-main">
|
||||||
|
main
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="Layout-sidebar">
|
||||||
|
sidebar
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h4>Container-md centered on viewport</h4>
|
||||||
|
|
||||||
|
<div class="Layout Layout--left-sidebar">
|
||||||
|
<div class="Layout-main">
|
||||||
|
<div class="Layout-center-container-md">
|
||||||
|
<div class="container-md">
|
||||||
|
main
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="Layout-sidebar">
|
||||||
|
sidebar
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h4>Container-lg centered on viewport</h4>
|
||||||
|
|
||||||
|
<div class="Layout Layout--left-sidebar">
|
||||||
|
<div class="Layout-main">
|
||||||
|
<div class="Layout-center-container-lg">
|
||||||
|
<div class="container-lg">
|
||||||
|
main
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="Layout-sidebar">
|
||||||
|
sidebar
|
||||||
|
</div>
|
||||||
|
</div>
|
@ -1,36 +0,0 @@
|
|||||||
const path = require('path')
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
siteMetadata: {
|
|
||||||
title: 'Primer CSS',
|
|
||||||
shortName: 'CSS',
|
|
||||||
description: "CSS for GitHub's Primer design system",
|
|
||||||
imageUrl: 'https://user-images.githubusercontent.com/586552/47590375-121cad80-d93a-11e8-89f2-a1cf108e0548.png'
|
|
||||||
},
|
|
||||||
pathPrefix: '/css',
|
|
||||||
plugins: [
|
|
||||||
{
|
|
||||||
resolve: '@primer/gatsby-theme-doctocat',
|
|
||||||
options: {
|
|
||||||
defaultBranch: 'main',
|
|
||||||
repoRootPath: '..'
|
|
||||||
}
|
|
||||||
},
|
|
||||||
'gatsby-plugin-sass',
|
|
||||||
{
|
|
||||||
resolve: 'gatsby-plugin-svgr',
|
|
||||||
options: {
|
|
||||||
svgo: false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
resolve: `gatsby-plugin-alias-imports`,
|
|
||||||
options: {
|
|
||||||
alias: {
|
|
||||||
'styled-components': path.resolve(__dirname, 'node_modules', 'styled-components'),
|
|
||||||
react: path.resolve(__dirname, 'node_modules', 'react')
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
24979
docs/yarn.lock
24979
docs/yarn.lock
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user