Thanks to visit codestin.com
Credit goes to github.com

Skip to content

KMT-879: Make org.jetbrains.compose.ui.tooling.preview.PreviewParameterProvider an actual implementation of androidx.compose.ui.tooling.preview.PreviewParameterProvider on Android (#5319) #5323

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 20, 2025
Merged

KMT-879: Make org.jetbrains.compose.ui.tooling.preview.PreviewParameterProvider an actual implementation of androidx.compose.ui.tooling.preview.PreviewParameterProvider on Android (#5319) #5323

merged 1 commit into from
May 20, 2025

Conversation

@boiler23
Copy link
Collaborator

@boiler23 boiler23 commented May 20, 2025 •
edited by igordmn
Loading

This is required for the preview parameters to be correctly picked up by the preview adapter in IDE, which expects the provider to be a subclass of AndroidX's interface, and fails with the ClassCastException otherwise.

Fixes https://youtrack.jetbrains.com/issue/CMP-8220

Release Notes

Fixes - Multiple Platforms

  • Support Preview parameters for Previews in common source sets in IJ and AS. Note: IDEs also need to implement support on their end. Please check the respective IDE release notes to confirm this is supported.

Example usage:

import androidx.compose.runtime.Composable
import org.jetbrains.compose.ui.tooling.preview.Preview
import org.jetbrains.compose.ui.tooling.preview.PreviewParameter
import org.jetbrains.compose.ui.tooling.preview.PreviewParameterProvider

class MyPreviewParameterProvider : PreviewParameterProvider<String> {
    override val values = sequenceOf("Hello, Compose!", "Hello, World!")
}

/**
 * This function will generate two preview images with different texts.
 */
@Preview
@Composable
fun MyPreview(@PreviewParameter(MyPreviewParameterProvider::class) text: String) {
    Text(text)
}

Testing

Once https://youtrack.jetbrains.com/issue/KMT-879 is merged in IJ, this change can be tested on Nightly Builds (ETA tomorrow)

@boiler23
KMT-879: Make `org.jetbrains.compose.ui.tooling.preview.PreviewParame…
a9f2589 
…terProvider` an actual implementation of `androidx.compose.ui.tooling.preview.PreviewParameterProvider` on Android (#5319)

This is required for the preview parameters to be correctly picked up by
the preview adapter in IDE, which expects the provider to be a subclass
of AndroidX's interface, and fails with the `ClassCastException`
otherwise.

## Release Notes
### Fixes - Multiple Platforms
- Support Preview parameters for Previews in common source sets in IJ
and AS. Note: IDEs also need to implement support on their end. Please
check the respective IDE release notes to confirm this is supported.

Example usage:

```
import androidx.compose.runtime.Composable
import org.jetbrains.compose.ui.tooling.preview.Preview
import org.jetbrains.compose.ui.tooling.preview.PreviewParameter
import org.jetbrains.compose.ui.tooling.preview.PreviewParameterProvider

class MyPreviewParameterProvider : PreviewParameterProvider<String> {
    override val values = sequenceOf("Hello, Compose!", "Hello, World!")
}

/**
 * This function will generate two preview images with different texts.
 */
@Preview
@composable
fun MyPreview(@PreviewParameter(MyPreviewParameterProvider::class) text: String) {
    Text(text)
}
```
@boiler23 boiler23 requested a review from Kpotko May 20, 2025 12:24
@Kpotko Kpotko merged commit 03fe09d into release/1.8 May 20, 2025
1 check passed
@Kpotko Kpotko deleted the ilia.bogdanovich/KMT-879-preview-parameters-1.8 branch May 20, 2025 13:17
igordmn added a commit that referenced this pull request Jul 2, 2025
@igordmn
Changelog. Fix multi-line release notes blank lines
5cfbb04 
When the 1.8.2 release was prepared, the release notes from #5323 were malformed by stripping empty lines:
```
- Support Preview parameters for Previews in common source sets in IJ and AS. Note: IDEs also need to implement support on their end. Please check the respective IDE release notes to confirm this is supported [#5323](#5323)
  Example usage:
  \\\
  import androidx.compose.runtime.Composable
  import org.jetbrains.compose.ui.tooling.preview.Preview
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameter
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameterProvider
  class MyPreviewParameterProvider : PreviewParameterProvider<String> {
    override val values = sequenceOf("Hello, Compose!", "Hello, World!")
  }
  /**
   * This function will generate two preview images with different texts
   */
  @Preview
  @composable
  fun MyPreview(@PreviewParameter(MyPreviewParameterProvider::class) text: String) {
    Text(text)
  }
  \\\
```

The correct release notes are:
```
- Support Preview parameters for Previews in common source sets in IJ and AS. Note: IDEs also need to implement support on their end. Please check the respective IDE release notes to confirm this is supported [#5323](#5323)

  Example usage:

  \\\
  import androidx.compose.runtime.Composable
  import org.jetbrains.compose.ui.tooling.preview.Preview
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameter
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameterProvider

  class MyPreviewParameterProvider : PreviewParameterProvider<String> {
      override val values = sequenceOf("Hello, Compose!", "Hello, World!")
  }

  /**
   * This function will generate two preview images with different texts.
   */
  @Preview
  @composable
  fun MyPreview(@PreviewParameter(MyPreviewParameterProvider::class) text: String) {
      Text(text)
  }
  \\\
```

To fix this issue, the parsing is changed. Previously `ChangelogEntry` represented a single line, even if it is part of a single change. Now it represents the change as a whole.

## Testing
These commands give the same result, with the exception that multiline release notes are handled correctly now:
```
kotlin changelog.main.kts v1.8.1..v1.9.0-alpha02
kotlin changelog.main.kts v1.8.1..v1.8.2
kotlin changelog.main.kts v1.8.0..v1.8.1
kotlin changelog.main.kts v1.8.0-beta02..v1.8.0-rc01
```

## Release Notes
N/A
@igordmn igordmn mentioned this pull request Jul 2, 2025
Merged
igordmn added a commit that referenced this pull request Jul 2, 2025
@igordmn
Changelog. Fix multi-line release notes blank lines
62dba8f 
When the 1.8.2 release was prepared, the release notes from #5323 were malformed by stripping empty lines:
```
- Support Preview parameters for Previews in common source sets in IJ and AS. Note: IDEs also need to implement support on their end. Please check the respective IDE release notes to confirm this is supported [#5323](#5323)
  Example usage:
  \\\
  import androidx.compose.runtime.Composable
  import org.jetbrains.compose.ui.tooling.preview.Preview
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameter
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameterProvider
  class MyPreviewParameterProvider : PreviewParameterProvider<String> {
    override val values = sequenceOf("Hello, Compose!", "Hello, World!")
  }
  /**
   * This function will generate two preview images with different texts
   */
  @Preview
  @composable
  fun MyPreview(@PreviewParameter(MyPreviewParameterProvider::class) text: String) {
    Text(text)
  }
  \\\
```

The correct release notes are:
```
- Support Preview parameters for Previews in common source sets in IJ and AS. Note: IDEs also need to implement support on their end. Please check the respective IDE release notes to confirm this is supported [#5323](#5323)

  Example usage:

  \\\
  import androidx.compose.runtime.Composable
  import org.jetbrains.compose.ui.tooling.preview.Preview
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameter
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameterProvider

  class MyPreviewParameterProvider : PreviewParameterProvider<String> {
      override val values = sequenceOf("Hello, Compose!", "Hello, World!")
  }

  /**
   * This function will generate two preview images with different texts.
   */
  @Preview
  @composable
  fun MyPreview(@PreviewParameter(MyPreviewParameterProvider::class) text: String) {
      Text(text)
  }
  \\\
```

To fix this issue, the parsing is changed. Previously `ChangelogEntry` represented a single line, even if it is part of a single change. Now it represents the change as a whole.

## Testing
These commands give the same result, with the exception that multiline release notes are handled correctly now:
```
kotlin changelog.main.kts v1.8.1..v1.9.0-alpha02
kotlin changelog.main.kts v1.8.1..v1.8.2
kotlin changelog.main.kts v1.8.0..v1.8.1
kotlin changelog.main.kts v1.8.0-beta02..v1.8.0-rc01
```

## Release Notes
N/A
terrakok pushed a commit that referenced this pull request Jul 2, 2025
@igordmn
Changelog. Fix multi-line release notes blank lines (#5348)
0a68f00 
When the 1.8.2 release was prepared, the release notes from
#5323 were
malformed by stripping empty lines:
```
- Support Preview parameters for Previews in common source sets in IJ and AS. Note: IDEs also need to implement support on their end. Please check the respective IDE release notes to confirm this is supported [#5323](#5323)
  Example usage:
  \\\
  import androidx.compose.runtime.Composable
  import org.jetbrains.compose.ui.tooling.preview.Preview
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameter
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameterProvider
  class MyPreviewParameterProvider : PreviewParameterProvider<String> {
    override val values = sequenceOf("Hello, Compose!", "Hello, World!")
  }
  /**
   * This function will generate two preview images with different texts
   */
  @Preview
  @composable
  fun MyPreview(@PreviewParameter(MyPreviewParameterProvider::class) text: String) {
    Text(text)
  }
  \\\
```

The correct release notes are:
```
- Support Preview parameters for Previews in common source sets in IJ and AS. Note: IDEs also need to implement support on their end. Please check the respective IDE release notes to confirm this is supported [#5323](#5323)

  Example usage:
  
  \\\
  import androidx.compose.runtime.Composable
  import org.jetbrains.compose.ui.tooling.preview.Preview
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameter
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameterProvider
  
  class MyPreviewParameterProvider : PreviewParameterProvider<String> {
      override val values = sequenceOf("Hello, Compose!", "Hello, World!")
  }
  
  /**
   * This function will generate two preview images with different texts.
   */
  @Preview
  @composable
  fun MyPreview(@PreviewParameter(MyPreviewParameterProvider::class) text: String) {
      Text(text)
  }
  \\\
```

To fix this issue, the parsing is changed. Previously `ChangelogEntry`
represented a single line, even if it is part of a single change. Now it
represents the change as a whole.

## Testing
These commands give the same result, with the exception that multiline
release notes are handled correctly now:
```
kotlin changelog.main.kts v1.8.1..v1.9.0-alpha02
kotlin changelog.main.kts v1.8.1..v1.8.2
kotlin changelog.main.kts v1.8.0..v1.8.1
kotlin changelog.main.kts v1.8.0-beta02..v1.8.0-rc01
```

## Release Notes
N/A
henryqwe pushed a commit to henryqwe/compose-multiplatform that referenced this pull request Oct 1, 2025
@igordmn
Changelog. Fix multi-line release notes blank lines (JetBrains#5348)
a1a8c2a 
When the 1.8.2 release was prepared, the release notes from
JetBrains#5323 were
malformed by stripping empty lines:
```
- Support Preview parameters for Previews in common source sets in IJ and AS. Note: IDEs also need to implement support on their end. Please check the respective IDE release notes to confirm this is supported [JetBrains#5323](JetBrains#5323)
  Example usage:
  \\\
  import androidx.compose.runtime.Composable
  import org.jetbrains.compose.ui.tooling.preview.Preview
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameter
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameterProvider
  class MyPreviewParameterProvider : PreviewParameterProvider<String> {
    override val values = sequenceOf("Hello, Compose!", "Hello, World!")
  }
  /**
   * This function will generate two preview images with different texts
   */
  @Preview
  @composable
  fun MyPreview(@PreviewParameter(MyPreviewParameterProvider::class) text: String) {
    Text(text)
  }
  \\\
```

The correct release notes are:
```
- Support Preview parameters for Previews in common source sets in IJ and AS. Note: IDEs also need to implement support on their end. Please check the respective IDE release notes to confirm this is supported [JetBrains#5323](JetBrains#5323)

  Example usage:
  
  \\\
  import androidx.compose.runtime.Composable
  import org.jetbrains.compose.ui.tooling.preview.Preview
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameter
  import org.jetbrains.compose.ui.tooling.preview.PreviewParameterProvider
  
  class MyPreviewParameterProvider : PreviewParameterProvider<String> {
      override val values = sequenceOf("Hello, Compose!", "Hello, World!")
  }
  
  /**
   * This function will generate two preview images with different texts.
   */
  @Preview
  @composable
  fun MyPreview(@PreviewParameter(MyPreviewParameterProvider::class) text: String) {
      Text(text)
  }
  \\\
```

To fix this issue, the parsing is changed. Previously `ChangelogEntry`
represented a single line, even if it is part of a single change. Now it
represents the change as a whole.

## Testing
These commands give the same result, with the exception that multiline
release notes are handled correctly now:
```
kotlin changelog.main.kts v1.8.1..v1.9.0-alpha02
kotlin changelog.main.kts v1.8.1..v1.8.2
kotlin changelog.main.kts v1.8.0..v1.8.1
kotlin changelog.main.kts v1.8.0-beta02..v1.8.0-rc01
```

## Release Notes
N/A
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Kpotko Kpotko Kpotko approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@boiler23 @Kpotko