Как да използвам Chakra UI с Next.js и React

Изграждането на уеб сайтове и приложения е трудно. Има много неща, които трябва да обмислите, за да сте сигурни, че нашите приложения са използваеми и достъпни, включително как работят нашите React компоненти.

Как можем да се възползваме от мощта на Chakra UI за създаване на страхотни уеб приложения?

  • Какво е Chakra UI?
  • Какво прави потребителския интерфейс на Chakra толкова страхотен?
  • Какво ще строим?
  • Стъпка 0: Създаване на нов проект на React с Next.js
  • Стъпка 1: Инсталиране и конфигуриране на Chakra UI в Next.js
  • Стъпка 2: Добавяне на компоненти на Chakra UI към приложение React
  • Стъпка 3: Направете отзивчиви компоненти с Chakra UI
  • Стъпка 4: Персонализиране на темата за потребителския интерфейс Chakra по подразбиране

Какво е Chakra UI?

Chakra UI е библиотека на компоненти за React, която улеснява изграждането на потребителския интерфейс на приложение или уебсайт.

Целта им е да осигурят прост, модулен и достъпен набор от компоненти за бързо стартиране и работа.

Какво прави потребителския интерфейс на Chakra толкова страхотен?

За начало по подразбиране Chakra се стреми да направи всеки компонент достъпен. Това е критична част от разработването на приложения, която често се пренебрегва, а поддържащите Чакра са се постарали да гарантират, че компонентите следват насоките на WAI-ARIA.

Chakra включва и прост API, позволяващ на разработчиците да станат продуктивни. Тя позволява на хората и екипите да правят приобщаващи приложения, без да се притеснявате дали сами ще създадете куп компоненти.

За оформяне и персонализиране Chakra използва Emotion под капака, за да предостави на разработчиците възможността да оформят компонентите си точно в JavaScript с помощта на стилови подпори. Той се предлага с тема по подразбиране, но позволява възможността лесно да се замени с персонализирани настройки.

Какво ще строим?

За да получим добра представа за това как работи Chakra, ние по същество ще възстановим шаблона Next.js по подразбиране с компоненти на Chakra UI.

Това ще ни помогне да разберем няколко важни концепции, като например как да използваме Chakra UI с Next.js, как да добавяме персонализирани стилове с реквизит и как да персонализираме темата на Chakra UI.

Концепциите тук могат да се приложат почти за всяко приложение на React, въпреки че примерите ще бъдат малко специфични за Next.js.

Стъпка 0: Създаване на нов проект на React с Next.js

За да започнем, се нуждаем от приложение React. Ще използваме Next.js като нашата рамка, която ще ни даде възможност лесно да завъртим ново приложение.

След като влезете в директорията, в която искате да създадете своя проект, изпълнете:

yarn create next-app my-chakra-app # or npx create-next-app my-chakra-app 

Забележка: не се колебайте да преминете my-chakra-appкъм каквото искате да назовете директорията на проекта.

И след като приключите, можете да навигирате в тази директория и да стартирате проекта с:

yarn dev # or npm run dev 

Това трябва да завърти вашия сървър за разработка на // localhost: 3000 и ние трябва да сме готови за работа!

Следвайте заедно с ангажимента!

Стъпка 1: Инсталиране и конфигуриране на Chakra UI в Next.js

След това нека инсталираме Chakra UI.

Вътре в директорията на вашия проект изпълнете:

yarn add @chakra-ui/core @emotion/core @emotion/styled emotion-theming # or npm install @chakra-ui/core @emotion/core @emotion/styled emotion-theming 

Това ще инсталира Chakra UI и неговите зависимости, което включва Emotion, тъй като разчита на него за стила.

За да накараме Chakra да работи вътре в нашето приложение, трябва да конфигурираме доставчик в основата на нашето приложение. Това ще позволи на всички компоненти на Chakra да говорят помежду си и да използват конфигурацията, за да поддържат последователни стилове.

Вътре pages/_app.js, първо нека импортираме нашия доставчик в горната част:

import { ThemeProvider, theme } from '@chakra-ui/core'; 

След това заменете оператора return в компонента със:

function MyApp({ Component, pageProps }) { return (    ) } 

Както ще забележите, ние също предаваме themeпроменлива на нашия доставчик. Импортираме темата по подразбиране на Chakra UI директно от Chakra и я предаваме в нашата, ThemeProviderза да могат всички наши компоненти да получат стиловете и конфигурациите по подразбиране.

И накрая, искаме да добавим компонент, наречен CSSResetright, като пряко дъщеря на нашия ThemeProvider.

Първо, добавете CSSResetкато импорт:

import { ThemeProvider, theme, CSSReset } from '@chakra-ui/core'; 

След това добавете компонента направо вътре ThemeProvider:

И сега, ако презаредим страницата, можем да видим, че нещата изглеждат малко по-различно!

Браузърът се предлага с много стилове по подразбиране и по подразбиране Chakra UI не ги заменя. Това включва стилове като граници на елемент от бутон.

Въпреки че не е задължително да се нуждаем от CSS Reset тук, бихме могли да заменим тези неща ръчно. Това ни осигурява основа, в която ще знаем, че потребителският интерфейс на Chakra работи по предназначение и можем да започнем да добавяме нашите компоненти.

Следвайте заедно с ангажимента!

Стъпка 2: Добавяне на компоненти на Chakra UI към приложение React

Сега за забавната част. Ще използваме компоненти на Chakra UI, за да се опитаме да възстановим шаблона по подразбиране Next.js. Няма да изглежда на 100% точно така, но ще носи духа и можем да го персонализираме, както ни се иска.

Изграждане на заглавието и описанието

Започвайки отгоре, нека актуализираме заглавието и описанието си.

В горната част на страницата трябва да импортираме нашия Headingкомпонент:

import { Heading, Link } from "@chakra-ui/core"; 

Тогава нека заменим

Original text


с:

 Welcome to Next.js!  

Тук използваме компонента Heading, който след това задаваме като „an“ h1. Можем да използваме всяко име на етикет на HTML заглавие, но тъй като заместваме h1, искаме да го използваме.

Ние също така задаваме sizeатрибут, който ни позволява да контролираме колко голяма е заглавието, както и mb, което означава margin-bottom, което ни позволява да добавим малко пространство отдолу.

И вече виждаме, че нашата страница изглежда по-скоро като шаблон по подразбиране.

Ние също искаме да добавим обратно нашата връзка.

Добавете Linkкъм нашето изявление за импортиране в горната част и след това вътре в нашия компонент заменете текста Next.js с:

Next.js! 

Chakra’s Link component creates a link as expected, but then allows us to use the style props to customize it. Here, we’re using the color variable teal.500 that Chakra provides to change our link to Chakra’s colors.

And we can see that we have our Next.js link!

The last piece of the header is the description. For that, we want to use the Text component.

Add Text  and Code to the import statement and replace the description with:

 Get started by editing pages/index.js

We’re using the Text component to recreate a

tag and the Code component to create our tag. Similar to our Heading component, we’re adding a fontSize to make the font bigger and mt which stands for margin-top to add some space above it.

And now we have our header!

Replacing info cards with Chakra UI components

For each of our cards, we can use the same concepts as we did with the header to recreate each of our boxes.

To start, add an import for the Flex component and replace the tag with:

 ...  

Make sure to leave all of the cards inside of the Flex component. The Flex component will recreate our grid by adding Flexbox along with the same properties that were on the grid before.

At this point, it should exactly the same as it did before.

Next, add Box to the import statement and then replace the first card with:

 Documentation → Find in-depth information about Next.js features and API.  

Similar to our Heading component, we’re setting our Box component “as” an tag allowing it to serve as a link. We then configure our style props to replicate our cards.

Inside of that, we use the Heading and Text component to recreate the actual content of the cards.

And after only changing the first card, we can now see the changes:

Now, we can go back and replace the other three cards with the same components to finish recreating our grid.

For fun, we can add a 5th card that links to Chakra UI:

 Chakra UI → Build accessible React apps & websites with speed.  

And with all of our changes, we can now see our recreated Next.js starting template!

Follow along with the commit!

Step 3: Making responsive components with Chakra UI

Part of what the default Next.js grid was able to provide was the ability for the cards to expand to full width once the size of the browser becomes small enough. This is particularly relevant at 600px, which typically means someone’s on a mobile device.

If we look at our page on a mobile device, we can see that our cards aren’t filling up the entire width.

Chakra allows us to set responsive styles with its baked in sizing, allowing us to easily recreate our responsive grid cards.

To do this, instead of passing in a single value to our style props, we can pass in an array.

For instance, on each of our Box components, let’s update the flexBasis prop to:

flexBasis={['auto', '45%']} 

Here, according to Chakra’s default responsive breakpoints , we’re saying that by default, we want our flexBasis to be set as auto. But for anything 480px and larger, again which is Chakra’s default first breakpoint, we set it to 45%.

Chakra considers its responsive styling to be mobile first, which is why you see the 480px act as a minimum size, not a maximum size.

And with that change, we can now see that on a large device, we still have our grid.

But now on mobile, our cards take up the entire width!

Using the array pattern works for all of the breakpoints, so if you wanted more control over your styles, Chakra lets you do that.

Follow along with the commit!

Step 4: Customizing the default Chakra UI theme

While Chakra provides a pretty great default theme, we also have the ability to customize it to our liking to match our brand or personal taste.

For instance, while the teal that we used for our Heading link is great and uses Chakra’s styles, what if I wanted to customize all links to use the purple that I use on my website?

To start, Chakra comes with a default purple, so we can update our link to use that purple:

Welcome to Next.js! 

And we see our change.

That looks great, but let’s update it to the exact purple I use.

Inside of pages/_app.js, we’re going to create a new object at the top of the page, where we spread the default theme creating a new theme object. We’ll also replace the theme prop with our new object:

const customTheme = { ...theme } function MyApp({ Component, pageProps }) { return (  

If we save and reload the page, it will look exactly the same.

Next, we want to update the colors, so in our custom theme object, let’s add the colors property, where we can then set our custom purple:

const customTheme = { ...theme, colors: { ...theme.colors, purple: '#692ba8' } } 

Note: you’ll see here that we’re also spreading theme.colors. If we don’t, we’ll be replacing the colors object with only the purple value, meaning we won’t have any other colors.

But if we reload the page, our link isn’t purple anymore!

Chakra typically uses ranges of colors which allows us to use different shades of each of the colors. In our Link component, we’re specifying purple.500 which we didn’t set to exist.

So to fix that, we can use a tool like Smart Swatch to get all of our color values that we need and set those in our custom theme object:

const customTheme = { ...theme, colors: { ...theme.colors, purple: { 50: '#f5e9ff', 100: '#dac1f3', 200: '#c098e7', 300: '#a571dc', 400: '#8c48d0', 500: '#722fb7', 600: '#59238f', 700: '#3f1968', 800: '#260f40', 900: '#10031a', } } } 

Tip: Smart Swatch actually lets you copy those values as a JavaScript object, making it easier to paste into our theme!

And now if we reload the page, we can see our purple!

While we used a range value here, we can also specify color variables without a range.

Say I wanted to leave the default Chakra purple “as is” but provide a way for me to reference my purple.

To do that, I could remove those purple values and add a new custom variable:

const customTheme = { ...theme, colors: { ...theme.colors, spacejelly: '#692ba8' } } 

Then update my Link to use that color:

Welcome to Next.js! 

And we can see that we’re now using our purple without overriding the original:

We can apply this to most parts of the styles of Chakra, including Typography and setting custom Breakpoints. It’s another way to make our project custom to our own while still taking advantage of the power of Chakra!

Follow along with the commit!

What else can you do with Chakra UI?

While we went through some simpler examples, it really opens the door to more complex style changes and controls that Chakra provides with its component APIs.

There are also a whole lot of awesome components that you can use to transform your website or application and make development fast and easy!

They even provide recipes that have some examples of how you can combine the components resulting in powerful functionality. This includes a responsive header and even adding animations with Framer Motion.

Follow me for more Javascript, UX, and other interesting things!

  • ? Follow Me On Twitter
  • ? Subscribe To My Youtube
  • ✉️ Sign Up For My Newsletter
  • ? Sponsor Me