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

Fix/doc change metadetails #424

Open
wants to merge 48 commits into
base: staging
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
6f153fe
change in meta title and meta description in default theme
Nov 30, 2022
1eacd99
change in meta title and meta description in customizing fonts
Nov 30, 2022
063a971
change in meta title and meta description in customizing theme
Nov 30, 2022
98e430e
change in meta title and meta description in customizing components
Nov 30, 2022
b14ec0f
change in meta title and meta description in dark-mode
Dec 1, 2022
d55decb
change in meta title and meta description in breakpoints
Dec 1, 2022
8d47dfe
change in meta title and meta description in typescript
Dec 1, 2022
767ba9b
change in meta title and meta description in aspect-ratio
Dec 1, 2022
eef31ae
change in meta title and meta description in box
Dec 1, 2022
b89d8fa
change in meta title and meta description in center
Dec 1, 2022
f4989e4
change in meta title and meta description in flex
Dec 1, 2022
a00164d
change in meta title and meta description in container
Dec 1, 2022
a078128
change in meta title and meta description in hstack
Dec 1, 2022
833cea3
change in meta title and meta description in stack
Dec 1, 2022
01ebb62
change in meta title and meta description in vstack
Dec 1, 2022
86c389b
change in meta title and meta description in zstack
Dec 1, 2022
38ca5be
change in meta title and meta description in badge
Dec 1, 2022
91ea6ad
change in meta title and meta description in divider
Dec 1, 2022
de048d0
change in meta title and meta description in alert
Dec 1, 2022
6fb5b52
change in meta title and meta description in progress
Dec 1, 2022
9d76aa5
change in meta title and meta description in skeleton
Dec 1, 2022
d016d14
change in meta title and meta description in spinner
Dec 1, 2022
6ef235a
change in meta title and meta description in toast
Dec 1, 2022
d65fb43
change in meta title and meta description in avatar
Dec 1, 2022
6961084
change in meta title and meta description in icon
Dec 1, 2022
7889389
change in meta title and meta description in image
Dec 1, 2022
0cb1f11
change in meta title and meta description in presence-transition
Dec 1, 2022
62d4e49
change in meta title and meta description in slide
Dec 1, 2022
1a29d85
change in meta title and meta description in stagger
Dec 1, 2022
8610f8f
change in meta title and meta description in scrollview & view
Dec 1, 2022
4f2cfe9
change in meta title and meta description in KeyboardAvoidingView
Dec 1, 2022
b19a133
change in meta title and meta description in status-bar
Dec 1, 2022
10c9b9e
change in meta title and meta description in flat-list
Dec 1, 2022
4c2e624
change in meta title and meta description in section-list
Dec 1, 2022
0c4730d
change in meta title and meta description in todo-list
Dec 1, 2022
d5b1d41
change in meta title and meta description in kitchen-sink
Dec 1, 2022
8be0e2e
change in meta title and meta description in app-bar
Dec 1, 2022
ed2f472
change in meta title and meta description in building-card
Dec 1, 2022
1051655
change in meta title and meta description in building-drawer-navigation
Dec 1, 2022
48d085e
change in meta title and meta description in building-tab-view
Dec 1, 2022
459493f
change in meta title and meta description in building-swipe-list
Dec 1, 2022
576c371
change in meta title and meta description in building-app-drawer
Dec 1, 2022
4bcd892
change in meta title and meta description in building-footer-tabs
Dec 1, 2022
9856241
change in meta title and meta description in migration-v3
Dec 1, 2022
db29727
change in meta title and meta description in migration-v3xtov32
Dec 1, 2022
847bf36
change in meta title and meta description in migration-v33xtov34x
Dec 1, 2022
14c57e0
change in meta title and meta description in theme
Dec 1, 2022
5d44450
remove console in logouts/index
Dec 5, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/3.0.x/alert.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: alert
title: Alert
metaTitle: Alert | NativeBase
metaDescription: The Alert component in NativeBase is used to convey warnings and important messages to the user. Explore alert component types with examples in this document.
---

import { ComponentTheme } from '../../src/components';
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/avatar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: avatar
title: Avatar
metaTitle: Avatar | NativeBase
metaDescription: "The Avatar component in NativeBase can display profile pictures, or a fallback image as a representation of the user. More on avatar icon types with examples."
---

import { ComponentTheme } from '../../src/components';
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/badge.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: badge
title: Badge
metaTitle: Badge | NativeBase
metaDescription: Migrating Badge to NativeBase v3 will provide a lot more design, size, variant, and customization, options. More on migrating Badge components in this document.
---

import { ComponentTheme } from '../../src/components';
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/box.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: box
title: Box
metaTitle: Box | NativeBase
metaDescription: Box in NativeBase is a generic component for low-level layout needs. More on box component types- basic, composition, with linear gradient, and box (with ref).
---

This is a generic component for low level layout needs. It is similar to a [`div`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div) in HTML.
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/breakpoints.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: breakpoint
title: Breakpoints
metaTitle: Breakpoints | NativeBase
metaDescription: Breakpoints are the building blocks of responsive design. NativeBase provides some default breakpoints which you can check out and update using extendTheme.
---

Breakpoints are the building blocks of responsive design. Use them to control when your layout can be adapted at a particular viewport or device size.
Expand Down
3 changes: 3 additions & 0 deletions docs/3.0.x/building-app-bar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
id: building-app-bar
title: AppBar
metaTitle: AppBar | NativeBase
metaDescription: The App Bar in NativeBase provides content and actions related to the current screen. This document shows how you can create it using layout components.

---

The top app bar provides content and actions related to the current screen. It’s used for branding, screen titles, navigation, and actions.
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/building-app-drawer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: appDrawer
title: App drawer
metaTitle: App drawer | NativeBase
metaDescription: Creating an app drawer-like layout in NativeBase is very simple using FlatList. Read this document to learn more about how to create an app drawer with example.
---

Creating an app drawer like layout is very common and with NativeBase's SimpleGrid make this extremely simple while still keeping it extremely customisable. Here is an example to illustrate it.
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/building-card.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: buildingCard
title: Card
metaTitle: Card | NativeBase
metaDescription: In NativeBase, a card is a flexible and extensible content container. Read this document to learn more about cards, how to create them, and the most common designs.
---

A card is a flexible and extensible content container. It comes in caries shapes and sizes and here we'll make few of them.
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/building-drawer-navigation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: buildingDrawerNavigation
title: Drawer Navigation
metaTitle: Drawer Navigation | NativeBase
metaDescription: In NativeBase, a common pattern in Drawer Navigation is to use drawer from the left or right side for navigating between screens. Read this to know more.
---

Common pattern in navigation is to use drawer from left (sometimes right) side for navigating between screens.
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/building-footer-tabs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: building-footer-tabs
title: Footer
metaTitle: Footer | NativeBase
metaDescription: Making Footer in our apps is very simple in NativeBase V3. Read this document where we explain how to make Footer using HStack component with useful examples.
---

With NativeBase v3 we have removed FooterTab components because as it's very simple to create it using HStack component. Here is an example of how we can make Footer in our Apps.
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/building-swipe-list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: building-swipe-list
title: Swipe List
metaTitle: Swipe List | NativeBase
metaDescription: SwipeList View in NativeBase is a vertical ListView with rows that swipe open and close. Read to learn how we can use React Native Swipe List in NativeBase.
---

SwipeListView is a vertical ListView with rows that swipe open and closed. Handles default native behavior such as closing rows when ListView is scrolled or when other rows are opened.
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/building-tab-view.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: building-tab-view
title: Tab View
metaTitle: Tab View | NativeBase
metaDescription: This is a cross-platform Tab View component for React Native that can be used in NativeBase. Read this document to learn more about the component with examples.
---

A cross-platform Tab View component for React Native
Expand Down
4 changes: 3 additions & 1 deletion docs/3.0.x/center.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
id: center
title: Center
metaTitle: Center | NativeBase
metaDescription: In NativeBase, center aligns its contents to the center within itself. More on center types and examples such as basic, icon frames, and square and circle.
---

`Center` aligns its contents to the center within itself. It is a layout component.

## Import

```jsx
import { Center, Square, Circle } from 'native-base';
import { Center, Square, Circle } from "native-base";
```

- **Center:** Centers its child, pass `width` and `height`
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/container.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: container
title: Container
metaTitle: Container | NativeBase
metaDescription: The Container in NativeBase restricts a content width according to the current breakpoint while keeping the size fluid. More on Container usage with examples.
---

The `Container` restricts a content's width according to current breakpoint, while keeping the size fluid.
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/customizing-components.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: customizingComponents
title: Customising Components
metaTitle: Customizing Components | NativeBase
metaDescription: Theme customization is at the heart of NativeBase. Learn how to customize components easily with examples and the difference between baseStyle and defaultProps.
---

Theme customisation is at the heart of NativeBase. Using NativeBase's `extendTheme` function, we can customise components.
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/customizing-fonts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: customizingFonts
title: Customising Fonts
metaTitle: Customizing Fonts | NativeBase
metaDescription: Adding a custom font family can be done in React Native by following three simple steps. Read on to know the steps to follow and how to use fonts in NativeBase.
---

Follow 3 simple steps to add a custom font family.
Expand Down
56 changes: 29 additions & 27 deletions docs/3.0.x/customizing-theme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: customizingTheme
title: Customising Theme
metaTitle: Customizing Theme | NativeBase
metaDescription: The theme is one of the core elements of NativeBase. Learn more about the theme of NativeBase, what it looks like, and how to customize it to your liking.
---

import { NativeBaseProvider, Box } from 'native-base';
Expand All @@ -23,34 +25,34 @@ The Theme is one of the core elements of NativeBase. You can customize NativeBas
It has many [other properties](default-theme) but in this recipe, we will update only a few of them (namely colors, fonts, and config) using NativeBase's `extendTheme` function.

```tsx
import React from 'react';
import { NativeBaseProvider, extendTheme } from 'native-base';
import { Content } from './Content';
import React from "react";
import { NativeBaseProvider, extendTheme } from "native-base";
import { Content } from "./Content";

export default function () {
const theme = extendTheme({
colors: {
// Add new color
primary: {
50: '#E3F2F9',
100: '#C5E4F3',
200: '#A2D4EC',
300: '#7AC1E4',
400: '#47A9DA',
500: '#0088CC',
600: '#007AB8',
700: '#006BA1',
800: '#005885',
900: '#003F5E',
50: "#E3F2F9",
100: "#C5E4F3",
200: "#A2D4EC",
300: "#7AC1E4",
400: "#47A9DA",
500: "#0088CC",
600: "#007AB8",
700: "#006BA1",
800: "#005885",
900: "#003F5E",
},
// Redefining only one shade, rest of the color will remain same.
amber: {
400: '#d97706',
400: "#d97706",
},
},
config: {
// Changing initialColorMode to 'dark'
initialColorMode: 'dark',
initialColorMode: "dark",
},
});

Expand All @@ -77,25 +79,25 @@ function Example() {
colors: {
// Add new color
primary: {
50: '#E3F2F9',
100: '#C5E4F3',
200: '#A2D4EC',
300: '#7AC1E4',
400: '#47A9DA',
500: '#0088CC',
600: '#007AB8',
700: '#006BA1',
800: '#005885',
900: '#003F5E',
50: "#E3F2F9",
100: "#C5E4F3",
200: "#A2D4EC",
300: "#7AC1E4",
400: "#47A9DA",
500: "#0088CC",
600: "#007AB8",
700: "#006BA1",
800: "#005885",
900: "#003F5E",
},
// Redefining only one shade, rest of the color will remain same.
amber: {
400: '#d97706',
400: "#d97706",
},
},
config: {
// Changing initialColorMode to 'dark'
initialColorMode: 'dark',
initialColorMode: "dark",
},
});

Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/dark-mode.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: darkMode
title: Making Components Dark Mode Compatible
metaTitle: Making components dark mode compatible | NativeBase
metaDescription: Most of the components in NativeBase are dark mode compatible. In case you might need to make your component respond to color mode, follow this guideline.
---

By default, most of NativeBase's components are dark mode compatible. In some scenario, you might need to make your component respond to color mode. There are 2 ways to achieve this:
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/default-theme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: default-theme
title: Default Theme
metaTitle: Default Theme | NativeBase
metaDescription: Theming in NativeBase is based on the Styled System Specification. Learn more here about default theme and how to use theme object in NativeBase.
---

import { ColorsBlock, FontBlocks, SpaceBlocks } from "../../src/components/index";
Expand Down
4 changes: 3 additions & 1 deletion docs/3.0.x/divider.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: divider
title: Divider
metaTitle: Divider | NativeBase
metaDescription: "In NativeBase, Divider can visually separate content in a given list or group. Learn more here about basic, divider orientation, and composition with examples."
---

import { ComponentTheme } from '../../src/components';
Expand All @@ -10,7 +12,7 @@ import { ComponentTheme } from '../../src/components';
## Import

```jsx
import { Divider } from 'native-base';
import { Divider } from "native-base";
```

## Examples
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/flat-list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: flatList
title: FlatList
metaTitle: FlatList | NativeBase
metaDescription: FlatList component in NativeBase can be used for rendering performant scrollable lists. Read this document to know more about FlatList uses along with examples.
---

A component for rendering performant scrollable lists.
Expand Down
4 changes: 3 additions & 1 deletion docs/3.0.x/flex.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
id: flex
title: Flex
metaTitle: Flex | NativeBase
metaDescription: Flex in NativeBase provides helpful style shorthand and is a Box with display:flex. Learn about the usage of flex components with examples in this document.
---

`Flex` provides helpful style shorthand and is a [`Box`](box.md) with `display: flex`.

## Import

```jsx
import { Flex, Spacer } from 'native-base';
import { Flex, Spacer } from "native-base";
```

- `Flex`: a **[Box](box.md)** with `display: flex`
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/hstack.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: hStack
title: HStack / Row
metaTitle: HStack / Row | NativeBase
metaDescription: HStack in NativeBase aligns items horizontally. Row is also an alias for HStack. Learn more about aligning with this component with examples in this document.
---

`HStack` aligns items horizontally. `Row` is also an alias for `HStack`.
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/icon.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: icon
title: Icon
metaTitle: Icon | NativeBase
metaDescription: Learn all the different ways in which NativeBase allows you to use icons. Get to know more about creating custom icons and more icon functions in this document.
---

You can use icons in multiple ways in NativeBase:
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/image.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: image
title: Image
metaTitle: Image | NativeBase
metaDescription: "The image component in NativeBase allows the display of images. An analysis of image sizes, border radius, fallback and other examples of this component here."
---

Generic Image components from [React Native](https://reactnative.dev).
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/keyboard-avoiding-view.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: keyboardAvoidingView
title: KeyboardAvoidingView
metaTitle: KeyboardAvoidingView | NativeBase
metaDescription: In NativeBase KeyboardAvoidingView provides a view that moves out of the way of virtual keyboard automatically. More information on KeyboardAvoidingView here.
---

Provides a view that moves out of the way of virtual keyboard automatically. It is a component to solve the common problem of views that need to move out of the way of the virtual keyboard. It can automatically adjust either its height, position, or bottom padding based on the keyboard height.
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/kitchen-sink.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: kitchen-sink
title: Kitchen Sink
metaTitle: Kitchen Sink | NativeBase
metaDescription: Kitchen Sink is a comprehensive demo app showing all the components of NativeBase in action. Check out this document for more information on Kitchen Sink app.
---

import { KitchenSinkIframe, TileLink, NBHistory } from "../../src/components";
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/migration/v3.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: Guide
title: Guide to v3
metaTitle: Upgrading to v3 | NativeBase
metaDescription: NativeBase V3 comes with a lot of changes in philosophy and API. If you are looking to upgrade from NativeBase V2 to V3 in your app, you can take a look here.
---

`v3` comes with a lot of changes in philosophy as well as the API. We have re-imagined how we should code for React Native as well as web. Keeping this in mind, you might come across a lot of changes while upgrading from v2 to v3. This might seem to be a bit of tedious work but we promise you, it will be worth it!
Expand Down
2 changes: 2 additions & 0 deletions docs/3.0.x/presence-transition.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: presence-transition
title: PresenceTransition
metaTitle: PresenceTransition | NativeBase
metaDescription: PresenceTransition component in NativeBase provides a declarative API to add entry and exit transitions. Read this document to know more about the component.
---

PresenceTransition provides a declarative API to add entry and exit transitions.
Expand Down
4 changes: 3 additions & 1 deletion docs/3.0.x/progress.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
id: progress
title: Progress
metaTitle: Progress | NativeBase
metaDescription: "The Progress component in NativeBase helps show the progress status for a time-consuming task that consists of several steps. Read this document to learn more."
---

import { ComponentTheme } from '../../src/components';
Expand All @@ -10,7 +12,7 @@ import { ComponentTheme } from '../../src/components';
## Import

```jsx
import { Progress } from 'native-base';
import { Progress } from "native-base";
```

## Examples
Expand Down
Loading