Skip to content

Commit

Permalink
docs(many): restore slides and virtual scroll docs (#2737)
Browse files Browse the repository at this point in the history
  • Loading branch information
liamdebeasi committed Jan 30, 2023
1 parent c3f7e52 commit 07c1aaa
Show file tree
Hide file tree
Showing 10 changed files with 1,165 additions and 55 deletions.
10 changes: 3 additions & 7 deletions versioned_docs/version-v6/angular/slides.md
Expand Up @@ -10,13 +10,9 @@ title: Slides
/>
</head>

:::caution Looking for `ion-slides`?
We recommend <a href="http://swiperjs.com/" target="_blank" rel="noopener noreferrer">Swiper.js</a> if you need a modern touch slider component. It powers our `ion-slides` component, but we now recommend that developers use Swiper for Angular directly.

`ion-slides` was deprecated in v6.0.0 and removed in v7.0.0. We recommend using the Swiper.js library directly. The migration process is detailed below.

:::

We recommend <a href="http://swiperjs.com/" target="_blank" rel="noopener noreferrer">Swiper.js</a> if you need a modern touch slider component. This guide will go over how to get Swiper for Angular set up in your Ionic Framework application. It will also go over any migration information you may need to move from `ion-slides` to the official Swiper Angular integration.
This guide will go over how to get Swiper for Angular set up in your Ionic Framework application. It will also go over any migration information you may need to move from `ion-slides` to the official Swiper Angular integration.

## Getting Started

Expand Down Expand Up @@ -438,4 +434,4 @@ Before opening an issue, please consider creating a post on the <a href="https:/

If you are running into problems with the Swiper library, new bugs should be filed on the Swiper repo: <a href="https://github.com/nolimits4web/swiper/issues" target="_blank" rel="noopener noreferrer">https://github.com/nolimits4web/swiper/issues</a>

If you are running into problems with the `IonicSlides` module, new bugs should be filed on the Ionic Framework repo: <a href="https://github.com/ionic-team/ionic-framework/issues" target="_blank" rel="noopener noreferrer">https://github.com/ionic-team/ionic-framework/issues</a>
If you are running into problems with the `IonicSlides` module, new bugs should be filed on the Ionic Framework repo: <a href="https://github.com/ionic-team/ionic-framework/issues" target="_blank" rel="noopener noreferrer">https://github.com/ionic-team/ionic-framework/issues</a>
10 changes: 3 additions & 7 deletions versioned_docs/version-v6/angular/virtual-scroll.md
@@ -1,12 +1,8 @@
# Virtual Scroll

:::caution Looking for `ion-virtual-scroll`?
In the past, we have provided an `ion-virtual-scroll` component in Ionic Framework to help with list virtualization. At the time this was not available in Angular, but recently Angular has provided its own solution via the `@angular/cdk` package.

`ion-virtual-scroll` was deprecated in v6.0.0 and removed in v7.0.0. We recommend using the `@angular/cdk` package detailed below.

:::

## Installation
## Setup

To setup the CDK Scroller, first install `@angular/cdk`:

Expand Down Expand Up @@ -130,4 +126,4 @@ For example:

## Further Reading

This only covers a small portion of what the CDK Virtual Scroller is capable of. For more details, please see the [Angular CDK Virtual Scrolling docs](https://material.angular.io/cdk/scrolling/overview).
This only covers a small portion of what the CDK Virtual Scroller is capable of. For more details, please see the [Angular CDK Virtual Scrolling docs](https://material.angular.io/cdk/scrolling/overview).
60 changes: 60 additions & 0 deletions versioned_docs/version-v6/api/slide.md
@@ -0,0 +1,60 @@
---
title: "ion-slide"
hide_table_of_contents: true
---
import TOCInline from '@theme/TOCInline';

import Props from '@site/static/auto-generated/slide/props.md';
import Events from '@site/static/auto-generated/slide/events.md';
import Methods from '@site/static/auto-generated/slide/methods.md';
import Parts from '@site/static/auto-generated/slide/parts.md';
import CustomProps from '@site/static/auto-generated/slide/custom-props.md';
import Slots from '@site/static/auto-generated/slide/slots.md';

<head>
<title>ion-slide | Slide API Component for Ionic Framework Apps</title>
<meta name="description" content="Slide is a child API component of Slides—written as ion-slide. Any slide content should be written in this component and used in conjunction with Slides." />
</head>

import EncapsulationPill from '@components/page/api/EncapsulationPill';



<h2 className="table-of-contents__title">Contents</h2>

<TOCInline
toc={toc}
maxHeadingLevel={2}
/>

:::note
This component has been deprecated in favor of using Swiper.js directly. Please see the [Slides Documentation](./slides#migration) for a migration guide.
:::


The Slide component is a child component of [Slides](./slides). The template
should be written as `ion-slide`. Any slide content should be written
in this component and it should be used in conjunction with [Slides](./slides).

See the [Slides API Docs](./slides) for more usage information.




## Properties
<Props />

## Events
<Events />

## Methods
<Methods />

## CSS Shadow Parts
<Parts />

## CSS Custom Properties
<CustomProps />

## Slots
<Slots />

1 comment on commit 07c1aaa

@vercel
Copy link

@vercel vercel bot commented on 07c1aaa Jan 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

ionic-docs – ./

ionic-docs-ionic1.vercel.app
ionic-docs-gqykycf8t.vercel.app
ionic-docs-git-main-ionic1.vercel.app

Please sign in to comment.