‫Codelab: ساختن مؤلفه Sidenav

این codelab به شما آموزش می‌دهد که چگونه یک مؤلفه چیدمان پیمایش کناری لغزشی واکنش‌گرا در وب بسازید. همان‌طور که پیش می‌رویم، مؤلفه را می‌سازیم، ابتدا با HTML، سپس CSS، و بعد JavaScript.

پست وبلاگ من با عنوان ساختن مؤلفه Sidenav را بررسی کنید تا با ویژگی‌های پلاتفرم وب CSS انتخاب‌شده برای ساختن این مؤلفه آشنا شوید.

راه‌اندازی

  1. روی بازآمیزی برای ویرایش کلیک کنید تا پروژه قابل‌ویرایش شود.
  2. باز کردن app/index.html.

HTML

ابتدا، اصول راه‌اندازی HTML را دریافت کنید تا محتوا و چند کادر برای کار کردن داشته باشید.

HTML زیر را در برچسب <body> رها کنید.

<aside></aside>
<main></main>

<aside> منو پیمایش را به‌عنوان عنصر تکمیلی برای <main> نگه می‌دارد، که محتوای اصلی صفحه را نگه می‌دارد.

سپس آن عناصر معنایی را با بقیه محتوای صفحه پر می‌کنیم.

یک عنصر پیمایش، چند پیوند پیمایش، و یک پیوند بستن در داخل عنصر <aside> اضافه کنید.

<aside>
  <nav>
    <h4>My</h4>
    <a href="#">Dashboard</a>
    <a href="#">Profile</a>
    <a href="#">Preferences</a>
    <a href="#">Archive</a>

    <h4>Settings</h4>
    <a href="#">Accessibility</a>
    <a href="#">Theme</a>
    <a href="#">Admin</a>
  </nav>

  <a href="#"></a>
</aside>

پیوندها در عناصر <nav> عالی هستند و عناصر <nav> در نوارهای کناری <aside> عالی هستند. بااین‌حال، کارهای بیشتری می‌توانیم برای بهبود انجام دهیم.

در عنصر محتوای اصلی، یک سرصفحه و یک مقاله اضافه کنید تا محتوای چیدمان را به‌صورت معنایی نگه دارد.

<main>
  <header>
    <a href="#sidenav-open" class="hamburger">
      <svg viewBox="0 0 50 40">
        <line x1="0" x2="100%" y1="10%" y2="10%" />
        <line x1="0" x2="100%" y1="50%" y2="50%" />
        <line x1="0" x2="100%" y1="90%" y2="90%" />
      </svg>
    </a>
    <h1>Site Title</h1>
  </header>

  <article>
    {put some placeholder content here}
  </article>
</main>

سرصفحه پیوند باز کردن منو را دارد. دکمه بستن در حاشیه قرار دارد. به‌زودی عناصر را براساس اندازه ناحیه نمایش نشان می‌دهیم و پنهان می‌کنیم.

در عنصر <article>، جمله جای‌بانی را جای‌گذاری کردیم. `` را با محتوای خودتان جایگزین کنید، یا متن لورم ارائه‌شده در زیر را جای‌گذاری کنید:

<h2>Totam Header</h2>
<p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Cum consectetur, necessitatibus velit officia ut impedit veritatis temporibus soluta? Totam odit cupiditate facilis nisi sunt hic necessitatibus voluptatem nihil doloribus! Enim.</p>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>

<h3>Subhead Totam Odit</h3>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>

<h3>Subhead</h3>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>

این محتوا و طول آن باعث می‌شود که وقتی از ارتفاع ناحیه نمایش فراتر می‌رود، صفحه پیمایش‌پذیر شود.

تا اینجا یک عنصر aside با nav، پیوندها، و روشی برای بستن sidenav اضافه کرده‌اید. همچنین یک سرصفحه، راهی برای باز کردن sidenav، و یک مقاله به عنصر اصلی اضافه کردید. این تمیز، معنایی و درحال‌حاضر بسیار بی‌زمان است، اما می‌توانیم آن را برای همه تمیزتر و واضح‌تر کنیم. پیوند باز در پیمایش کناری می‌تواند واضح‌تر علامت‌گذاری شود.

مشخصه‌های title و aria-label را به عنصر پیوند باز سرصفحه اضافه کنید:

<a href="#sidenav-open" class="hamburger">
<a href="#sidenav-open" title="Open Menu" aria-label="Open Menu" class="hamburger">

نماد SVG باز نیز می‌تواند واضح‌تر علامت‌گذاری شود. مشخصه‌های زیر را به SVG داخل عنصر پیوند باز اضافه کنید:

<svg viewBox="0 0 50 40">
<svg viewBox="0 0 50 40" role="presentation" focusable="false" aria-label="trigram for heaven symbol">

پیوند بستن در sidenav می‌تواند واضح‌تر علامت‌گذاری شود. مشخصه‌های title و aria-label را به عنصر پیوند بستن sidenav اضافه کنید:

<a href="#"></a>
<a href="#" title="Close Menu" aria-label="Close Menu"></a>

CSS

وقت چیدمان عناصر است. محتوای اصلی و نوار کناری فرزندان مستقیم برچسب <body> هستند، بنابراین جای خوبی برای شروع است.

CSS زیر را به css/sidenav.css اضافه کنید تا عنصر <body> فرزندان را طرح‌بندی کند.

body {
  display: grid;
  grid: [stack] 1fr / min-content [stack] 1fr;

  @media (max-width: 540px) {
    & > :matches(aside, main) {
      grid-area: stack;
    }
  }
}

این چیدمان اساساً می‌گوید: یک ردیف بانام stack با همه چیز در آن ایجاد کنید، و ۲ ستون در آن ردیف، که دومی نیز stack نام دارد. اندازه ستون اول باید براساس حداقل نیازهای محتوایی آن باشد و ستون دوم می‌تواند بقیه فضا را اشغال کند. سپس، اگر در نمای محدود 540px یا کمتر هستید، عناصر محتوای اصلی و پیمایش جانبی را در یک ردیف و ستون قرار دهید، که باعث می‌شود در یک شبکه ۱×۱ روی یکدیگر قرار بگیرند.

با این عملکرد پشته‌سازی واکنش‌گرا به‌عنوان پایه، اکنون می‌توانیم از وضعیت نوار نشانی برای تغییر وضعیت نمایان بودن و سبک انتقال sidenav استفاده کنیم.

عنصر <aside> را در app/index.html به‌روز کنید:

<aside>
<aside id="sidenav-open">

این کار به CSS امکان می‌دهد تا یک عنصر و درهم‌ساز نشانی وب را باهم مطابقت دهد. این مورد برای استفاده از :target مهم است. اکنون شناسه عنصر می‌تواند با درهم‌سازی نشانی وب که با برچسب‌های <a> تنظیم خواهیم کرد مطابقت داشته باشد.

علاوه‌براین، برای هدف‌یابی آسان‌تر جاوا اسکریپت، شناسه‌هایی برای عناصر کلیدی که sidenav را کنترل می‌کنند اضافه کنید. ابتدا شناسه‌ای به پیوند باز sidenav اضافه کنید:

<a href="#sidenav-open" class="hamburger" title="Open Menu" aria-label="Open Menu">
<a href="#sidenav-open" id="sidenav-button" class="hamburger" title="Open Menu" aria-label="Open Menu">

سپس، شناسه‌ای به پیوند بستن sidenav اضافه کنید:

<a href="#" title="Close Menu" aria-label="Close Menu"></a>
<a href="#" id="sidenav-close" title="Close Menu" aria-label="Close Menu"></a>

این کار چیدمان پشته‌ای واکنش‌گرای ماکرو <body> را تکمیل می‌کند و ما را به نوار نشانی وب متصل می‌کند. بیایید ادامه دهیم!

<aside> چیدمان مرتبی هم دارد. این عنصر دو فرزند دارد، یک <nav> که مؤلفه کاغذمانندی است که به‌صورت کشویی باز می‌شود، و یک عنصر پیوند بستن <a> که نشانی وب را روی # تنظیم می‌کند. The link is invisible to the right of the paper slide out nav; it's so folks can "click off" the visual component to dismiss it.

CSS زیر را به css/sidenav.css اضافه کنید:

#sidenav-open {
  display: grid;
  grid-template-columns: [nav] 2fr [escape] 1fr;
}

فکر کردم نسبت و نام‌ها در اینجا واقعاً لمس خوبی بودند، جایی که شبکه می‌تواند بدرخشد و کنترل زیادی به طراح بدهد.

Next I need to conditionally overlay the main content and persist my position through any document scrolling. این شغل برای position: sticky و برخی overscroll-behavior عالی است.

سبک‌های زیر را برای sidenav اضافه کنید:

#sidenav-open {
  display: grid;
  grid-template-columns: [nav] 2fr [escape] 1fr;

  @media (max-width: 540px) {
    position: sticky;
    top: 0;
    max-height: 100vh;
    overflow: hidden auto;
    overscroll-behavior: contain;

    visibility: hidden; /* not keyboard accessible when closed */
  }
}

Those styles ensure the sidenav is the viewport height, scrolls vertically and contains the scroll. و از همه مهم‌تر، عنصر را پنهان می‌کند. به‌طور پیش‌فرض، وقتی نمای دید 540px یا کوچک‌تر است، آن sidenav را پنهان کنید. مگر اینکه!

افزودن شبه‌گزینشگر :target به عنصر #sidenav-open:

#sidenav-open {

  @media (max-width: 540px) {

    &:target {
      visibility: visible;
    }
  }
}

وقتی شناسه آن عنصر و نوار نشانی وب یکسان است، visibility را روی visible تنظیم کنید. پس‌از پیمایش صفحه، منو کناری را باز کنید، یا وقتی پیمایش کناری باز است، صفحه را پیمایش کنید. نظر شما چیست؟

CSS زیر را به پایین app/sidenav.css اضافه کنید:

#sidenav-button,
#sidenav-close {
  -webkit-tap-highlight-color: transparent;
  -webkit-touch-callout: none;
  user-select: none;
  touch-action: manipulation;

  @media (min-width: 540px) {
    display: none;
  }
}

این سبک‌ها دکمه‌های باز و بسته کردن ما را هدف قرار می‌دهند، سبک‌های ضربه زدن و لمس کردن آن‌ها را مشخص می‌کنند، و همچنین وقتی اندازه درگاه‌های دید 540px یا بزرگ‌تر باشد، آن‌ها را پنهان می‌کنند.

برای جذاب‌تر کردن آن، بیایید تبدیل‌های CSS را با دسترسی‌پذیری محترمانه اضافه کنیم. CSS زیر را به css/sidenav.css اضافه کنید:

#sidenav-open {
  --easeOutExpo: cubic-bezier(0.16, 1, 0.3, 1);
  --duration: .6s;

  ...

  @media (max-width: 540px) {
    ...

    transform: translateX(-110vw);
    will-change: transform;
    transition:
      transform var(--duration) var(--easeOutExpo),
      visibility 0s linear var(--duration);

    &:target {
      visibility: visible;
      transform: translateX(0);
      transition: transform var(--duration) var(--easeOutExpo);
    }
  }

  @media (prefers-reduced-motion: reduce) {
    --duration: 1ms;
  }
}
A demo of the interaction with and without duration applied based on the `prefers-reduced-motion` media query.

افزودن جاوا اسکریپت

کلید Escape باید منو را ببندد. این جاوااسکریپت را به js/index.js اضافه کنید:

const sidenav = document.querySelector('#sidenav-open');

sidenav.addEventListener('keyup', e => {
  if (e.code === 'Escape') {
    document.location.hash = '';
  }
});

این کد به رویداد کلیدی در عنصر sidenav گوش می‌دهد. اگر Escape باشد، درهم‌سازی نشانی وب را خالی می‌کند و باعث می‌شود نوار کناری ناوبری خارج شود.

This next piece of UX JS is focus management. می‌خواهم باز و بسته کردن را آسان کنم، بنابراین صبر می‌کنم تا پیمایش کناری نوعی انتقال را به‌پایان برساند، سپس آن را با درهم‌سازی نشانی وب بررسی می‌کنم تا مشخص کنم که داخل است یا خارج. سپس از جاوا اسکریپت برای تنظیم تمرکز روی دکمه استفاده می‌کنم که مکمل دکمه‌ای است که آن‌ها به‌تازگی فشار داده‌اند.

جاوا اسکریپت زیر را به js/index.js اضافه کنید:

const closenav = document.querySelector('#sidenav-close');
const opennav = document.querySelector('#sidenav-button');

sidenav.addEventListener('transitionend', e => {
  if (e.propertyName !== 'transform') {
    return;
  }

  const isOpen = document.location.hash === '#sidenav-open';

  isOpen
    ? closenav.focus()
    : opennav.focus();
});

امتحان کنید

  • برای پیش‌دید کردن سایت، مشاهده برنامه را فشار دهید. سپس تمام‌صفحه تمام‌صفحه را فشار دهید.

نتیجه‌گیری

این خلاصه نیازهایی است که با این مؤلفه داشتم. می‌توانید آن را توسعه دهید، به‌جای نشانی وب آن را با وضعیت جاوا اسکریپت هدایت کنید، و به‌طور کلی آن را برای خودتان شخصی‌سازی کنید! همیشه چیزهای بیشتری برای اضافه کردن یا موارد استفاده بیشتری برای پوشش دادن وجود دارد.

css/brandnav.css را باز کنید تا سبک‌های غیرمرتبط با چیدمان را که برای این مؤلفه اعمال کرده‌ام بررسی کنید. فکر نمی‌کردم برای مجموعه ویژگی‌هایی که روی آن‌ها تمرکز کرده بودم مهم باشد و امیدوار بودم که جدا کردن سبک‌ها از چیدمان، کپی و جای‌گذاری را تشویق کند. ممکن است در آنجا چیزهای بیشتری برای یادگیری وجود داشته باشد!

چگونه مؤلفه‌های ناوبری جانبی واکنش‌گرا با قابلیت بیرون لغزیدن می‌سازید؟ آیا تا‌به‌حال بیش‌از ۱ عدد داشته‌اید، مثلاً یکی در هر طرف؟ خیلی دوست دارم راه‌حل شما را در ویدیو YouTube نمایش دهم، حتماً برایم توییت کنید یا در YouTube با کدتان نظر بگذارید، این کار به همه کمک می‌کند!